Skip to content

order.deleted

An order was deleted: when BIRP sends this event, what its data holds and an example of its body.

Version v1.2, updated

On this page

BIRP sends order.deleted to the webhook endpoints that receive it. This page says when it is sent and what data holds, with an example of the body.

When it is sent

The order was deleted in BIRP, or is no longer available through the API. data holds its id and "status": "deleted"; if the order comes back, the same id arrives with order.created.

Data

data holds only the id of the record and "status": "deleted".

Example

Body of order.deletedJSON
{
  "api_version": "v1",
  "data": {
    "id": "00000000-0000-4000-8000-000000000051",
    "status": "deleted"
  },
  "id": "00000000-0000-4000-8000-000000000110",
  "occurred_at": "2026-09-28T14:05:12.417Z",
  "type": "order.deleted"
}

Related

  • webhook-events
  • verify-webhook-signatures