Stable Webhook Event Types
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.
location.created
Emitted when a Location has been created.
Example LocationCreated
JSON
{
"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"
}location.onboarding.updated
Emitted when a Location's onboarding status has been updated.
Example LocationOnboardingUpdated
JSON
{
"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"
}mailItem.created
Emitted when a MailItem has been received.
Example MailItemCreated
JSON
{
"data": {
"archivedAt": null,
"barcodeId": "STABLE-TEST-123456",
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/ocr-results/result-1.json"
],
"readAt": null,
"recipients": {
"business": {
"id": "53e6d412-11d7-4b75-bf61-2cefd3723527",
"name": "Acme Inc"
},
"individual": {
"firstName": "Jane",
"id": "9a85898e-ee75-4378-b47b-99a9a8844c89",
"lastName": "Doe"
},
"line1": {
"text": "Acme Inc"
},
"line2": {
"text": "Jane Doe"
}
},
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.created"
}mailItem.deposit.completed
Emitted when a check has been sent to the bank for deposit.
Example MailItemDepositCompleted
JSON
{
"data": {
"archivedAt": null,
"barcodeId": "STABLE-TEST-123456",
"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://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/envelope-ocr-results/result-1.json"
],
"readAt": "2024-10-14T12:00:00Z",
"recipients": {
"business": null,
"individual": {
"firstName": "Jane",
"id": "9a85898e-ee75-4378-b47b-99a9a8844c89",
"lastName": "Doe"
},
"line1": {
"text": "Jane Doe"
},
"line2": null
},
"scanDetails": {
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/document-ocr-results/result-1.json",
"https://s3.amazonaws.com/stable/document-ocr-results/result-2.json"
],
"status": "completed"
},
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.deposit.completed"
}mailItem.deposit.processing
Emitted when a check deposit has been requested.
Example MailItemDepositProcessing
JSON
{
"data": {
"archivedAt": null,
"barcodeId": "STABLE-TEST-123456",
"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://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/envelope-ocr-results/result-1.json"
],
"readAt": null,
"recipients": {
"business": null,
"individual": null,
"line1": {
"text": "Cookies Inc."
},
"line2": {
"text": "John Smith"
}
},
"scanDetails": {
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/document-ocr-results/result-1.json",
"https://s3.amazonaws.com/stable/document-ocr-results/result-2.json"
],
"status": "completed"
},
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.deposit.processing"
}mailItem.forward.completed
Emitted whenever a forward has been sent to the recipient.
Example MailItemForwardCompleted
JSON
{
"data": {
"archivedAt": "2024-10-13T08:30:00Z",
"barcodeId": "STABLE-TEST-654321",
"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://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/envelope-ocr-results/result-1.json"
],
"readAt": "2024-10-14T09:15:00Z",
"recipients": {
"business": {
"id": "53e6d412-11d7-4b75-bf61-2cefd3723527",
"name": "Acme Inc"
},
"individual": {
"firstName": "Jane",
"id": "9a85898e-ee75-4378-b47b-99a9a8844c89",
"lastName": "Doe"
},
"line1": {
"text": "Acme Inc"
},
"line2": {
"text": "Jane Doe"
}
},
"scanDetails": null,
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.forward.completed"
}mailItem.forward.processing
Emitted when a forward has been requested.
Example MailItemForwardProcessing
JSON
{
"data": {
"archivedAt": "2024-10-13T08:30:00Z",
"barcodeId": "STABLE-TEST-654321",
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"forwardDetails": {
"status": "processing"
},
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/envelope-ocr-results/result-1.json"
],
"readAt": null,
"recipients": {
"business": {
"id": "53e6d412-11d7-4b75-bf61-2cefd3723527",
"name": "Acme Inc"
},
"individual": {
"firstName": "Jane",
"id": "9a85898e-ee75-4378-b47b-99a9a8844c89",
"lastName": "Doe"
},
"line1": {
"text": "Acme Inc"
},
"line2": {
"text": "Jane Doe"
}
},
"scanDetails": null,
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.forward.processing"
}mailItem.scan.completed
Emitted when the internal contents of a MailItem has been scanned.
Example MailItemScanCompleted
JSON
{
"data": {
"archivedAt": "2024-10-13T08:30:00Z",
"barcodeId": "STABLE-TEST-654321",
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/envelope-ocr-results/result-1.json"
],
"readAt": "2024-10-14T09:15:00Z",
"scanDetails": {
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"ocrResultUrls": null,
"status": "completed"
},
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.scan.completed"
}mailItem.scan.ocrCompleted
Emitted when a scan of the internal contents of a MailItem's OCR data is available.
Example MailItemScanOcrCompleted
JSON
{
"data": {
"archivedAt": "2024-10-13T08:30:00Z",
"barcodeId": "STABLE-TEST-654321",
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/envelope-ocr-results/result-1.json"
],
"readAt": "2024-10-14T09:15:00Z",
"recipients": {
"business": {
"id": "53e6d412-11d7-4b75-bf61-2cefd3723527",
"name": "Acme Inc"
},
"individual": {
"firstName": "Jane",
"id": "9a85898e-ee75-4378-b47b-99a9a8844c89",
"lastName": "Doe"
},
"line1": {
"text": "Acme Inc"
},
"line2": {
"text": "Jane Doe"
}
},
"scanDetails": {
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/document-ocr-results/result-1.json",
"https://s3.amazonaws.com/stable/document-ocr-results/result-2.json"
],
"status": "completed"
},
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.scan.ocrCompleted"
}mailItem.scan.processing
Emitted when a scan of the internal contents of a MailItem has been requested.
Example MailItemScanProcessing
JSON
{
"data": {
"archivedAt": "2024-10-13T08:30:00Z",
"barcodeId": "STABLE-TEST-654321",
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/envelope-ocr-results/result-1.json"
],
"readAt": null,
"recipients": {
"business": {
"id": "53e6d412-11d7-4b75-bf61-2cefd3723527",
"name": "Acme Inc"
},
"individual": {
"firstName": "Jane",
"id": "9a85898e-ee75-4378-b47b-99a9a8844c89",
"lastName": "Doe"
},
"line1": {
"text": "Acme Inc"
},
"line2": {
"text": "Jane Doe"
}
},
"scanDetails": {
"ocrResultUrls": null,
"status": "processing"
},
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.scan.processing"
}mailItem.shred.completed
Emitted when a MailItem has been shredded.
Example MailItemShredCompleted
JSON
{
"data": {
"archivedAt": "2024-10-13T08:30:00Z",
"barcodeId": "STABLE-TEST-654321",
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/envelope-ocr-results/result-1.json"
],
"readAt": "2024-10-14T09:15:00Z",
"recipients": {
"business": {
"id": "53e6d412-11d7-4b75-bf61-2cefd3723527",
"name": "Acme Inc"
},
"individual": {
"firstName": "Jane",
"id": "9a85898e-ee75-4378-b47b-99a9a8844c89",
"lastName": "Doe"
},
"line1": {
"text": "Acme Inc"
},
"line2": {
"text": "Jane Doe"
}
},
"scanDetails": null,
"shredDetails": {
"status": "completed"
},
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.shred.completed"
}mailItem.shred.processing
Emitted when a shred of a MailItem has been requested.
Example MailItemShredProcessing
JSON
{
"data": {
"archivedAt": "2024-10-13T08:30:00Z",
"barcodeId": "STABLE-TEST-654321",
"businessRecipient": "Acme Inc",
"checks": [],
"clearAt": "2025-01-01T00:00:00Z",
"from": "John Doe",
"id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
"imageUrl": "https://placehold.co/800?text=Hello+from+Stable&font=roboto",
"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"
},
"ocrResultUrls": [
"https://s3.amazonaws.com/stable/envelope-ocr-results/result-1.json"
],
"readAt": null,
"recipients": {
"business": {
"id": "53e6d412-11d7-4b75-bf61-2cefd3723527",
"name": "Acme Inc"
},
"individual": {
"firstName": "Jane",
"id": "9a85898e-ee75-4378-b47b-99a9a8844c89",
"lastName": "Doe"
},
"line1": {
"text": "Acme Inc"
},
"line2": {
"text": "Jane Doe"
}
},
"shredDetails": {
"status": "processing"
},
"tags": [
{
"assignedAt": "2024-10-10T00:30:00Z",
"createdAt": "2024-10-10T00:30:00Z",
"id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
"name": "Important"
}
]
},
"eventType": "mailItem.shred.processing"
}