Svix

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.

mailItem.created

Emitted when a MailItem has been received.

Example mailItem.created
JSON
{
  "data": {
    "id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
    "from": "John Doe",
    "checks": [],
    "clearAt": "2025-01-01T00:00:00Z",
    "imageUrl": "https://placekitten.com/600/500",
    "location": {
      "id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
      "type": "cmra",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "state": "CA",
        "postalCode": "94105"
      },
      "onboarding": {
        "status": "complete"
      }
    },
    "businessRecipient": "Acme Inc",
    "individualRecipient": null
  },
  "eventType": "mailItem.created"
}

mailItem.deposit.completed

Emitted when a check has been sent to the bank for deposit.

Example mailItem.deposit.completed
JSON
{
  "data": {
    "id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
    "from": "John Doe",
    "checks": [
      {
        "id": "eec1c58f-ef4b-475f-862c-2e09705591d7",
        "payee": "Jane",
        "payer": "John",
        "amount": 100,
        "currency": "USD",
        "checkNumber": 8675309
      }
    ],
    "clearAt": "2025-01-01T00:00:00Z",
    "imageUrl": "https://placekitten.com/600/400",
    "location": {
      "id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
      "type": "cmra",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "state": "CA",
        "postalCode": "94105"
      },
      "onboarding": {
        "status": "complete"
      }
    },
    "depositDetails": {
      "status": "completed",
      "trackingNumber": "1234567890"
    },
    "businessRecipient": null,
    "individualRecipient": "Jane Doe"
  },
  "eventType": "mailItem.deposit.completed"
}

mailItem.deposit.processing

Emitted when a check deposit has been requested.

Example mailItem.deposit.processing
JSON
{
  "data": {
    "id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
    "from": "John Doe",
    "checks": [
      {
        "id": "eec1c58f-ef4b-475f-862c-2e09705591d7",
        "payee": "Jane",
        "payer": "John",
        "amount": 100,
        "currency": "USD",
        "checkNumber": 8675309
      }
    ],
    "clearAt": "2025-01-01T00:00:00Z",
    "imageUrl": "https://placekitten.com/550/400",
    "location": {
      "id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
      "type": "cmra",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "state": "CA",
        "postalCode": "94105"
      },
      "onboarding": {
        "status": "complete"
      }
    },
    "depositDetails": {
      "status": "processing"
    },
    "businessRecipient": null,
    "individualRecipient": "Jane Doe"
  },
  "eventType": "mailItem.deposit.processing"
}

mailItem.forward.completed

Emitted whenever a forward has been sent to the recipient.

Example mailItem.forward.completed
JSON
{
  "data": {
    "id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
    "from": "John Doe",
    "checks": [],
    "clearAt": "2025-01-01T00:00:00Z",
    "imageUrl": "https://placekitten.com/400/400",
    "location": {
      "id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
      "type": "cmra",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "state": "CA",
        "postalCode": "94105"
      },
      "onboarding": {
        "status": "complete"
      }
    },
    "forwardDetails": {
      "cost": 55000,
      "status": "completed",
      "trackingNumber": "1234567890"
    },
    "businessRecipient": "Acme Inc",
    "individualRecipient": null
  },
  "eventType": "mailItem.forward.completed"
}

mailItem.forward.processing

Emitted when a forward has been requested.

Example mailItem.forward.processing
JSON
{
  "data": {
    "id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
    "from": "John Doe",
    "checks": [],
    "clearAt": "2025-01-01T00:00:00Z",
    "imageUrl": "https://placekitten.com/200/300",
    "location": {
      "id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
      "type": "cmra",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "state": "CA",
        "postalCode": "94105"
      },
      "onboarding": {
        "status": "complete"
      }
    },
    "forwardDetails": {
      "status": "processing"
    },
    "businessRecipient": "Acme Inc",
    "individualRecipient": null
  },
  "eventType": "mailItem.forward.processing"
}

mailItem.scan.completed

Emitted when the internal contents of a MailItem has been scanned.

Example mailItem.scan.completed
JSON
{
  "data": {
    "id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
    "from": "John Doe",
    "checks": [],
    "clearAt": "2025-01-01T00:00:00Z",
    "imageUrl": "https://placekitten.com/200/300",
    "location": {
      "id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
      "type": "cmra",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "state": "CA",
        "postalCode": "94105"
      },
      "onboarding": {
        "status": "complete"
      }
    },
    "scanDetails": {
      "status": "completed",
      "imageUrl": "https://placekitten.com/400/300",
      "ocrResultUrl": null
    },
    "businessRecipient": "Acme Inc",
    "individualRecipient": null
  },
  "eventType": "mailItem.scan.completed"
}

mailItem.scan.processing

Emitted when a scan of the internal contents of a MailItem has been requested.

Example mailItem.scan.processing
JSON
{
  "data": {
    "id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
    "from": "John Doe",
    "checks": [],
    "clearAt": "2025-01-01T00:00:00Z",
    "imageUrl": "https://placekitten.com/900/500",
    "location": {
      "id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
      "type": "cmra",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "state": "CA",
        "postalCode": "94105"
      },
      "onboarding": {
        "status": "complete"
      }
    },
    "scanDetails": {
      "status": "processing"
    },
    "businessRecipient": "Acme Inc",
    "individualRecipient": null
  },
  "eventType": "mailItem.scan.processing"
}

mailItem.shred.completed

Emitted when a MailItem has been shredded.

Example mailItem.shred.completed
JSON
{
  "data": {
    "id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
    "from": "John Doe",
    "checks": [],
    "clearAt": "2025-01-01T00:00:00Z",
    "imageUrl": "https://placekitten.com/900/500",
    "location": {
      "id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
      "type": "cmra",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "state": "CA",
        "postalCode": "94105"
      },
      "onboarding": {
        "status": "complete"
      }
    },
    "shredDetails": {
      "status": "completed"
    },
    "businessRecipient": "Acme Inc",
    "individualRecipient": null
  },
  "eventType": "mailItem.shred.completed"
}

mailItem.shred.processing

Emitted when a shred of a MailItem has been requested.

Example mailItem.shred.processing
JSON
{
  "data": {
    "id": "b67416b1-8b44-40d8-9842-6c457acc4bf8",
    "from": "John Doe",
    "checks": [],
    "clearAt": "2025-01-01T00:00:00Z",
    "imageUrl": "https://placekitten.com/800/400",
    "location": {
      "id": "70a3d702-bf1d-4153-8eb2-d3d889aff7f0",
      "type": "cmra",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "state": "CA",
        "postalCode": "94105"
      },
      "onboarding": {
        "status": "complete"
      }
    },
    "shredDetails": {
      "status": "completed"
    },
    "businessRecipient": "Acme Inc",
    "individualRecipient": null
  },
  "eventType": "mailItem.shred.processing"
}