Skip to content
Swft Docs

List webhook deliveries.

GET
/webhooks/deliveries
 
curl --request GET \
  --url 'https://api.swft.co.uk/webhooks/deliveries?status=pending&limit=50' \
  --header 'Authorization: Bearer <token>'

Returns the most-recent deliveries for the authenticated partner. Scoped to the workspace by default; pass X-Swft-Merchant to limit to one merchant. Filterable by event and status.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
event

Filter by event name (e.g. order.completed).

string

Filter by event name (e.g. order.completed).

status
string
Allowed values: pending succeeded failed abandoned
limit
integer
default: 50 >= 1 <= 200
after

ISO-8601 timestamp; returns rows created strictly before this.

string

ISO-8601 timestamp; returns rows created strictly before this.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Page of deliveries, most-recent first.

Media type application/json
object
deliveries
required
Array<object>
object
id
required
string
subscription_id
required
string | null format: uuid
merchant_id
required
string format: uuid
workspace_id
required
string | null format: uuid
event
required
string
target_url
required
string format: uri
attempt_count
required
integer
last_status_code
required
integer | null
last_error
required
string | null
next_attempt_at
required
string | null
succeeded_at
required
string | null
abandoned_at
required
string | null
created_at
required
string
next_after
required
string | null
Example generated
{
  "deliveries": [
    {
      "id": "example",
      "subscription_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "merchant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "event": "example",
      "target_url": "https://example.com",
      "attempt_count": 1,
      "last_status_code": 1,
      "last_error": "example",
      "next_attempt_at": "example",
      "succeeded_at": "example",
      "abandoned_at": "example",
      "created_at": "example"
    }
  ],
  "next_after": "example"
}

400

Section titled “400 ”

Bad request — malformed input or missing/invalid parameters.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

401

Section titled “401 ”

Missing or invalid authentication.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

403

Section titled “403 ”

Authenticated but not authorised (e.g. wrong workspace).

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

404

Section titled “404 ”

Resource not found.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

409

Section titled “409 ”

Conflict — idempotency-key reuse, duplicate resource, etc.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

429

Section titled “429 ”

Rate-limited.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

500

Section titled “500 ”

Internal server error.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}