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.
A Check we've transcribed from inside a MailItem.
check.created Emitted when a Check has been transcribed from inside a MailItem.
A Check we've transcribed from inside a MailItem.
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.
A Check we've transcribed from inside a MailItem.
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.
A Check we've transcribed from inside a MailItem.
location.created Emitted when a Location has been created.
A Location where mail is being received.
location.onboarding.updated Emitted when a Location's onboarding status has been updated.
A Location where mail is being received.
mailItem.created Emitted when a MailItem has been received.
Emitted when a data extraction result has been deleted.
Emitted when data extraction has failed for a scanned document.
Emitted when data extraction has completed successfully for a scanned document.
mailItem.deposit.completed Emitted when a check has been sent to the bank for deposit.
mailItem.deposit.processing Emitted when a check deposit has been requested.
mailItem.forward.completed Emitted whenever a forward has been sent to the recipient.
mailItem.forward.processing Emitted when a forward has been requested.
mailItem.scan.completed Emitted when the internal contents of a MailItem has been scanned.
mailItem.scan.ocrCompleted Emitted when a scan of the internal contents of a MailItem's OCR data is available.
mailItem.scan.processing Emitted when a scan of the internal contents of a MailItem has been requested.
mailItem.shred.completed Emitted when a MailItem has been shredded.
mailItem.shred.processing Emitted when a shred of a MailItem has been requested.
mailItem.summary.created Emitted when an AI-generated summary has been created for a scanned document.
mailItem.tag.assignmentUpdated Emitted when a tag is assigned to or removed from a Mail Item. Note: `scanDetails` will only be present if the tag assignment was updated _after_ the scan completed.
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.
Powered by