List deliveries of an endpoint

GET

/webhooks/endpoints/{id}/deliveries

const url = 'https://api.clearance.rest/webhooks/endpoints/example/deliveries?limit=50&status=pending';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.clearance.rest/webhooks/endpoints/example/deliveries?limit=50&status=pending' \
  --header 'X-API-Key: <X-API-Key>'

Newest first.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

string

>= 1 characters

Resource id.

Query Parameters

limit

integer

default: 50 >= 1 <= 200

Page size (1-200).

cursor

string

The next_cursor value of the previous page.

status

string

Allowed values: pending succeeded failed

Only deliveries in this state.

Responses

200

Default Response

application/json

object

success

required

boolean

deliveries

required

Array<object>

One event queued or sent to an endpoint.

object

required

string

endpoint_id

required

string

event_id

required

string

event_type

required

Event type (see the event type catalog; webhook.test for test events).

string

status

required

string

Allowed values: pending succeeded failed

attempt

required

integer

>= -9007199254740991 <= 9007199254740991

next_attempt_at

required

Any of:

string
null

UTC timestamp (ISO 8601).

string

last_status_code

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

last_error

required

string | null

created_at

required

UTC timestamp (ISO 8601).

string

delivered_at

required

Any of:

string
null

UTC timestamp (ISO 8601).

string

next_cursor

required

Any of:

string
null

Opaque cursor of the next page.

string

Example

{
  "success": true,
  "deliveries": [
    {
      "status": "pending"
    }
  ]
}

400

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

401

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

403

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

404

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}