List webhook deliveries - Spree Commerce documentation

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const deliveries = await client.webhookEndpoints.deliveries.list('whe_xxx')

{
  "data": [
    {
      "id": "whd_UkLWZg9DAJ",
      "event_name": "order.created",
      "event_id": null,
      "response_code": 200,
      "execution_time": 150,
      "error_type": null,
      "request_errors": null,
      "response_body": null,
      "success": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "delivered_at": "2026-01-15T12:00:00.000Z",
      "payload": {
        "event": "order.created",
        "data": {
          "id": 1
        }
      },
      "webhook_endpoint_id": "whe_UkLWZg9DAJ",
      "webhook_endpoint_url": "https://shop.example.com/webhooks"
    },
    {
      "id": "whd_gbHJdmfrXB",
      "event_name": "order.created",
      "event_id": null,
      "response_code": 500,
      "execution_time": 200,
      "error_type": null,
      "request_errors": null,
      "response_body": null,
      "success": false,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "delivered_at": "2026-01-15T12:00:00.000Z",
      "payload": {
        "event": "order.created",
        "data": {
          "id": 1
        }
      },
      "webhook_endpoint_id": "whe_UkLWZg9DAJ",
      "webhook_endpoint_url": "https://shop.example.com/webhooks"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 2,
    "pages": 1,
    "from": 1,
    "to": 2,
    "in": 2,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "record_not_found",
    "message": "Webhook endpoint not found"
  }
}

GET

api

admin

webhook_endpoints

{webhook_endpoint_id}

deliveries

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const deliveries = await client.webhookEndpoints.deliveries.list('whe_xxx')

{
  "data": [
    {
      "id": "whd_UkLWZg9DAJ",
      "event_name": "order.created",
      "event_id": null,
      "response_code": 200,
      "execution_time": 150,
      "error_type": null,
      "request_errors": null,
      "response_body": null,
      "success": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "delivered_at": "2026-01-15T12:00:00.000Z",
      "payload": {
        "event": "order.created",
        "data": {
          "id": 1
        }
      },
      "webhook_endpoint_id": "whe_UkLWZg9DAJ",
      "webhook_endpoint_url": "https://shop.example.com/webhooks"
    },
    {
      "id": "whd_gbHJdmfrXB",
      "event_name": "order.created",
      "event_id": null,
      "response_code": 500,
      "execution_time": 200,
      "error_type": null,
      "request_errors": null,
      "response_body": null,
      "success": false,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "delivered_at": "2026-01-15T12:00:00.000Z",
      "payload": {
        "event": "order.created",
        "data": {
          "id": 1
        }
      },
      "webhook_endpoint_id": "whe_UkLWZg9DAJ",
      "webhook_endpoint_url": "https://shop.example.com/webhooks"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 2,
    "pages": 1,
    "from": 1,
    "to": 2,
    "in": 2,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "record_not_found",
    "message": "Webhook endpoint not found"
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[event_name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`delivered_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`event_name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`execution_time`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`response_code`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`success`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: created_at, delivered_at, event_name, execution_time, id, response_code, success, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Bearer token for admin authentication

Path Parameters

webhook_endpoint_id

string

required

Parent webhook endpoint ID

Query Parameters

q[search]

string

Matches any of event name (partial, case-insensitive).

page

integer

Page number

limit

integer

Number of records per page

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

sort

string

Sort by field. Prefix with - for descending (e.g., -delivered_at).

fields

string

Comma-separated list of fields to include. id is always included.

Response

deliveries found

⌘I

​Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

Filters