This is the list of event types that we currently send. For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
Emitted when a Location has been created.
{
"data": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "authorize"
},
"type": "cmra"
},
"eventType": "location.created"
}
Emitted when a Location's onboarding status has been updated.
{
"data": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
},
"eventType": "location.onboarding.updated"
}
Emitted when a MailItem has been received.
{
"data": {
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/600/500",
"individualRecipient": null,
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
}
},
"eventType": "mailItem.created"
}
Emitted when a check has been sent to the bank for deposit.
{
"data": {
"businessRecipient": null,
"checks": [
{
"amount": 100,
"checkNumber": 8675309,
"currency": "USD",
"id": "eec1c58f-ef4b-475f-862c-2e09705591d7",
"payee": "Jane",
"payer": "John"
}
],
"clearAt": "2025-01-01T00:00:00Z",
"depositDetails": {
"status": "completed",
"trackingNumber": "1234567890"
},
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/600/400",
"individualRecipient": "Jane Doe",
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
},
"scanDetails": {
"imageUrl": "https://placekitten.com/400/300",
"ocrResultUrls": null,
"status": "completed"
}
},
"eventType": "mailItem.deposit.completed"
}
Emitted when a check deposit has been requested.
{
"data": {
"businessRecipient": null,
"checks": [
{
"amount": 100,
"checkNumber": 8675309,
"currency": "USD",
"id": "eec1c58f-ef4b-475f-862c-2e09705591d7",
"payee": "Jane",
"payer": "John"
}
],
"clearAt": "2025-01-01T00:00:00Z",
"depositDetails": {
"status": "processing"
},
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/550/400",
"individualRecipient": "Jane Doe",
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
},
"scanDetails": {
"imageUrl": "https://placekitten.com/400/300",
"ocrResultUrls": null,
"status": "completed"
}
},
"eventType": "mailItem.deposit.processing"
}
Emitted whenever a forward has been sent to the recipient.
{
"data": {
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"forwardDetails": {
"cost": 55000,
"status": "completed",
"trackingNumber": "1234567890"
},
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/400/400",
"individualRecipient": null,
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
}
},
"eventType": "mailItem.forward.completed"
}
Emitted when a forward has been requested.
{
"data": {
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"forwardDetails": {
"status": "processing"
},
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/200/300",
"individualRecipient": null,
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
}
},
"eventType": "mailItem.forward.processing"
}
Emitted when the internal contents of a MailItem has been scanned.
{
"data": {
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/200/300",
"individualRecipient": null,
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
},
"scanDetails": {
"imageUrl": "https://placekitten.com/400/300",
"ocrResultUrls": null,
"status": "completed"
}
},
"eventType": "mailItem.scan.completed"
}
Emitted when a scan of the internal contents of a MailItem's OCR data is available.
{
"data": {
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/200/300",
"individualRecipient": null,
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
},
"scanDetails": {
"imageUrl": "https://placekitten.com/400/300",
"ocrResultUrls": [
"https://example.com/ocr-result-1.json",
"https://example.com/ocr-result-2.json"
],
"status": "completed"
}
},
"eventType": "mailItem.scan.ocrCompleted"
}
Emitted when a scan of the internal contents of a MailItem has been requested.
{
"data": {
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/900/500",
"individualRecipient": null,
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
},
"scanDetails": {
"status": "processing"
}
},
"eventType": "mailItem.scan.processing"
}
Emitted when a MailItem has been shredded.
{
"data": {
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/900/500",
"individualRecipient": null,
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
},
"shredDetails": {
"status": "completed"
}
},
"eventType": "mailItem.shred.completed"
}
Emitted when a shred of a MailItem has been requested.
{
"data": {
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placekitten.com/800/400",
"individualRecipient": null,
"location": {
"address": {
"city": "San Francisco",
"line1": "123 Main St",
"line2": "Suite #1000",
"postalCode": "94105",
"state": "CA"
},
"id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
"metadata": null,
"onboarding": {
"status": "complete"
},
"type": "cmra"
},
"shredDetails": {
"status": "completed"
}
},
"eventType": "mailItem.shred.processing"
}