Skip to content
clearance.rest

Get a delivery

GET
/webhooks/deliveries/{id}
curl --request GET \
  --url https://api.clearance.rest/webhooks/deliveries/example \
  --header 'X-API-Key: <X-API-Key>'

Includes the event envelope that was sent as payload.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters

Resource id.

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
success
required
boolean
delivery
required

A delivery including the event envelope that was sent.

object
id
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:

UTC timestamp (ISO 8601).

string
last_status_code
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
last_error
required
string | null
created_at
required

UTC timestamp (ISO 8601).

string
delivered_at
required
Any of:

UTC timestamp (ISO 8601).

string
payload
required

The event envelope that is POSTed to the endpoint as the request body.

object
id
required

Event id (evt_…). Stays the same across redeliveries: deduplicate on it.

string
type
required

Event type; the test endpoint sends webhook.test.

string
Allowed values: number.status_changed number.rented number.assigned number.unassigned number.metadata_updated number.renewal_failed number.sms_received email_account.status_changed email_account.assigned email_account.unassigned email_account.connected email_account.metadata_updated email.received balance.low webhook.test
created_at
required

When the event happened (UTC, ISO 8601).

string
data
required

Event data; its fields depend on type (see the event type catalog).

object
key
additional properties
Example
{
  "success": true,
  "delivery": {
    "status": "pending",
    "payload": {
      "type": "number.status_changed"
    }
  }
}

401

Section titled “401”

Default Response

Media typeapplication/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

Section titled “403”

Default Response

Media typeapplication/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

Section titled “404”

Default Response

Media typeapplication/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
}