Webhook events

Each event is a POST of JSON to your endpoint, signed. How to check the signature and what to answer is in Webhooks.

order.createdAn order was made order.matchedA pending order was matched to the store's own order order.cancelledAn order was cancelled order.readyAn order was marked ready to ship order.shippedAn order was marked shipped order.deliveredAn order was finished as delivered distributor_order.status_changedA distributor order changed status pingA test event

order.created

An order was made

By the API, by FFL Checkout, or by staff.

Field	Type	Description
`id`required	`string`	Stable across retries and resends. Deduplicate on it.
`type`required	`string`
`created_at`required	`string (date-time)`
`api_version`required	`"v1"`
`data`required	`object`
data.`order_id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`
data.`status`required	`"pending" \| "open"`

JSON
{
  "id": "…",
  "type": "…",
  "created_at": "2026-10-16T14:02:11Z",
  "api_version": "v1",
  "data": {
    "order_id": "…",
    "intake_ref": "…",
    "source": "api",
    "status": "pending"
  }
}

order.matched

A pending order was matched to the store's own order

Field	Type	Description
`id`required	`string`	Stable across retries and resends. Deduplicate on it.
`type`required	`string`
`created_at`required	`string (date-time)`
`api_version`required	`"v1"`
`data`required	`object`
data.`order_id`required	`string`
data.`store_order_number`required	`string \| null`
data.`status`required	`"open"`

JSON
{
  "id": "…",
  "type": "…",
  "created_at": "2026-10-16T14:02:11Z",
  "api_version": "v1",
  "data": {
    "order_id": "…",
    "store_order_number": "…",
    "status": "open"
  }
}

order.cancelled

An order was cancelled

Field	Type	Description
`id`required	`string`	Stable across retries and resends. Deduplicate on it.
`type`required	`string`
`created_at`required	`string (date-time)`
`api_version`required	`"v1"`
`data`required	`object`
data.`order_id`required	`string`
data.`status`required	`"cancelled"`

JSON
{
  "id": "…",
  "type": "…",
  "created_at": "2026-10-16T14:02:11Z",
  "api_version": "v1",
  "data": {
    "order_id": "…",
    "status": "cancelled"
  }
}

order.ready

An order was marked ready to ship

Field	Type	Description
`id`required	`string`	Stable across retries and resends. Deduplicate on it.
`type`required	`string`
`created_at`required	`string (date-time)`
`api_version`required	`"v1"`
`data`required	`object`
data.`order_id`required	`string`

JSON
{
  "id": "…",
  "type": "…",
  "created_at": "2026-10-16T14:02:11Z",
  "api_version": "v1",
  "data": {
    "order_id": "…"
  }
}

order.shipped

An order was marked shipped

Field	Type	Description
`id`required	`string`	Stable across retries and resends. Deduplicate on it.
`type`required	`string`
`created_at`required	`string (date-time)`
`api_version`required	`"v1"`
`data`required	`object`
data.`order_id`required	`string`
data.`tracking`	`string \| null`
data.`shipped_at`required	`string (date-time)`

JSON
{
  "id": "…",
  "type": "…",
  "created_at": "2026-10-16T14:02:11Z",
  "api_version": "v1",
  "data": {
    "order_id": "…",
    "tracking": "…",
    "shipped_at": "2026-10-16T14:02:11Z"
  }
}

order.delivered

An order was finished as delivered

Field	Type	Description
`id`required	`string`	Stable across retries and resends. Deduplicate on it.
`type`required	`string`
`created_at`required	`string (date-time)`
`api_version`required	`"v1"`
`data`required	`object`
data.`order_id`required	`string`

JSON
{
  "id": "…",
  "type": "…",
  "created_at": "2026-10-16T14:02:11Z",
  "api_version": "v1",
  "data": {
    "order_id": "…"
  }
}

distributor_order.status_changed

A distributor order changed status

Carries the distributor's confirmation number and tracking when Rollmark has them, and the ids of the orders it serves.

Field	Type	Description
`id`required	`string`	Stable across retries and resends. Deduplicate on it.
`type`required	`string`
`created_at`required	`string (date-time)`
`api_version`required	`"v1"`
`data`required	`object`
data.`distributor_order_id`required	`string`
data.`po_number`required	`string`
data.`from`required	`string`
data.`to`required	`string`
data.`distributor`required	`string`
data.`confirmation_number`	`string \| null`
data.`tracking`	`string \| null`
data.`order_ids`required	`string[]`

JSON
{
  "id": "…",
  "type": "…",
  "created_at": "2026-10-16T14:02:11Z",
  "api_version": "v1",
  "data": {
    "distributor_order_id": "…",
    "po_number": "…",
    "from": "…",
    "to": "…",
    "distributor": "…",
    "confirmation_number": "…",
    "tracking": "…",
    "order_ids": [
      "…"
    ]
  }
}

ping

A test event

Sent by the test button and by POST /webhooks/{id}/test. It cannot be subscribed to.

Field	Type	Description
`id`required	`string`	Stable across retries and resends. Deduplicate on it.
`type`required	`string`
`created_at`required	`string (date-time)`
`api_version`required	`"v1"`
`data`required	`object`
data.`webhook_id`	`string`

JSON
{
  "id": "…",
  "type": "…",
  "created_at": "2026-10-16T14:02:11Z",
  "api_version": "v1",
  "data": {
    "webhook_id": "…"
  }
}