Webhook

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.

check.completed

Emitted when a check deposit has been completed.

Example CheckCompleted
JSON
[
  {
    "data": {
      "amount": 100,
      "checkNumber": "8675309",
      "createdAt": "2024-12-20T00:00:00Z",
      "currency": "USD",
      "failureDetails": null,
      "id": "6e1b1bb1-b65f-4c81-9569-4c13034f5517",
      "mailItemId": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
      "payee": "Jane",
      "payer": "John",
      "status": "notRequested",
      "statusTransitions": {
        "completed": "2024-12-22T00:00:00Z",
        "failed": null,
        "processing": "2024-12-21T00:00:00Z"
      }
    },
    "eventType": "check.completed"
  }
]

check.created

Emitted when a Check has been transcribed from inside a MailItem.

Example CheckCreated
JSON
[
  {
    "data": {
      "amount": 100,
      "checkNumber": "8675309",
      "createdAt": "2024-12-20T00:00:00Z",
      "currency": "USD",
      "failureDetails": null,
      "id": "6e1b1bb1-b65f-4c81-9569-4c13034f5517",
      "mailItemId": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
      "payee": "Jane",
      "payer": "John",
      "status": "notRequested",
      "statusTransitions": {
        "completed": null,
        "failed": null,
        "processing": null
      }
    },
    "eventType": "check.created"
  }
]

check.failed

Emitted when a check deposit has failed. **Additional details about failed checks**: - A check can transition from `completed` to `failed`, but the reverse transition is not possible. - If a check moves from `completed` to `failed`, this indicates a check reversal, and funds will have been deducted from your account. - If a check moves from `processing` to `failed`, this means the transaction was unsuccessful and will not appear in your dashboard.

Example CheckFailed
JSON
[
  {
    "data": {
      "amount": 100,
      "checkNumber": "8675309",
      "createdAt": "2024-12-20T00:00:00Z",
      "currency": "USD",
      "failureDetails": {
        "code": "image_out_of_focus",
        "description": "Image is out of focus."
      },
      "id": "6e1b1bb1-b65f-4c81-9569-4c13034f5517",
      "mailItemId": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
      "payee": "Jane",
      "payer": "John",
      "status": "failed",
      "statusTransitions": {
        "completed": null,
        "failed": "2024-12-22T00:00:00Z",
        "processing": "2024-12-21T00:00:00Z"
      }
    },
    "eventType": "check.failed"
  }
]

check.processing

Emitted when a check deposit has been requested. **Edge Case:** If a deposit is requested for a piece of mail before its checks have been transcribed, this event will not be emitted. Instead, the webhook events will transition directly from `created` to either `completed` or `failed` once the deposit processing finishes, bypassing the `processing` status entirely.

Example CheckProcessing
JSON
[
  {
    "data": {
      "amount": 100,
      "checkNumber": "8675309",
      "createdAt": "2024-12-20T00:00:00Z",
      "currency": "USD",
      "failureDetails": null,
      "id": "6e1b1bb1-b65f-4c81-9569-4c13034f5517",
      "mailItemId": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
      "payee": "Jane",
      "payer": "John",
      "status": "notRequested",
      "statusTransitions": {
        "completed": null,
        "failed": null,
        "processing": "2024-12-21T00:00:00Z"
      }
    },
    "eventType": "check.processing"
  }
]

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"
      },
      "status": "active",
      "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"
      },
      "status": "active",
      "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",
      "createdAt": "2024-10-01T09:50: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"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "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": "12345",
          "createdAt": "2024-12-20T00:00:00Z",
          "currency": "USD",
          "failureDetails": null,
          "id": "6e1b1bb1-b65f-4c81-9569-4c13034f5517",
          "mailItemId": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
          "payee": "Jane",
          "payer": "John",
          "status": "completed",
          "statusTransitions": {
            "completed": "2024-12-22T00:00:00Z",
            "failed": null,
            "processing": "2024-12-21T00:00:00Z"
          }
        }
      ],
      "clearAt": "2025-01-01T00:00:00Z",
      "createdAt": "2024-10-01T09:50: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"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "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": "12345",
          "createdAt": "2024-12-20T00:00:00Z",
          "currency": "USD",
          "failureDetails": null,
          "id": "6e1b1bb1-b65f-4c81-9569-4c13034f5517",
          "mailItemId": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
          "payee": "Jane",
          "payer": "John",
          "status": "processing",
          "statusTransitions": {
            "completed": null,
            "failed": null,
            "processing": "2024-12-21T00:00:00Z"
          }
        }
      ],
      "clearAt": "2025-01-01T00:00:00Z",
      "createdAt": "2024-10-01T09:50: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"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "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",
      "createdAt": "2024-10-01T09:50: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"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "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",
      "createdAt": "2024-10-01T09:50: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"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "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",
      "createdAt": "2024-10-01T09:50: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": null,
        "status": "completed"
      },
      "tags": [
        {
          "assignedAt": "2024-10-10T00:30:00Z",
          "createdAt": "2024-10-10T00:30:00Z",
          "id": "3fdb688a-1912-4ad6-a2ec-f039032de94b",
          "name": "Important"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "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",
      "createdAt": "2024-10-01T09:50: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"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "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",
      "createdAt": "2024-10-01T09:50: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"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "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",
      "createdAt": "2024-10-01T09:50: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"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "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",
      "createdAt": "2024-10-01T09:50: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"
        }
      ],
      "teams": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        },
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "eventType": "mailItem.shred.processing"
  }
]

mailItem.team.assignmentUpdated

Emitted when a team is assigned to or removed from a Mail Item. Note: `scanDetails` will only be present if the team assignment was updated _after_ the scan completed.

Example MailItemTeamAssignmentUpdated
JSON
[
  {
    "changes": {
      "teamsAdded": [
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ],
      "teamsRemoved": [
        {
          "id": "c86c99cf-5849-45e2-850b-5dc1546e3ad7",
          "name": "Legal"
        }
      ]
    },
    "data": {
      "archivedAt": "2024-10-13T08:30:00Z",
      "barcodeId": "STABLE-TEST-654321",
      "businessRecipient": "Acme Inc",
      "checks": [],
      "clearAt": "2025-01-01T00:00:00Z",
      "createdAt": "2024-10-01T09:50: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": {
        "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"
        }
      ],
      "teams": [
        {
          "id": "f144a8b3-2f17-49bc-abce-d7dd898fca86",
          "name": "Finance"
        }
      ]
    },
    "eventType": "mailItem.team.assignmentUpdated"
  }
]