List webhook deliveries

GET

/v1/webhook-deliveries

curl --request GET \
  --url 'https://api.iomza.com/v1/webhook-deliveries?limit=50' \
  --header 'Authorization: Bearer <token>'

• Production

The latest events sent to your endpoints, with each attempt’s result: to see why one didn’t arrive.

Authorizations

• apiKey

Parameters

Query Parameters

job_id

string

<= 40 characters

Only the deliveries of this job’s events.

limit

integer

default: 50 >= 1 <= 100

How many, 1–100 (50 by default).

Responses

200

The deliveries, newest first.

Media typeapplication/json

object

object

required

Allowed value: list

data

required

Array<object>

One event sent to one endpoint, with its attempts’ outcome (without the payload).

object

id

required

string

object

required

string

Allowed value: webhook_delivery

job_id

required

string | null

endpoint_id

required

string | null

url

required

string

event_id

required

string

event_type

required

string

status

required

string

Allowed values: pending delivered failed

attempts

required

number

last_status_code

required

number | null

last_error

required

string | null

next_attempt_at

required

string | null format: date-time

created_at

required

string format: date-time

delivered_at

required

string | null format: date-time

Example

{
  "object": "list",
  "data": [
    {
      "object": "webhook_delivery",
      "status": "pending"
    }
  ]
}

400

Invalid fields: details lists each problem with its path.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

401

The API key is missing, invalid or revoked.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

429

Too many requests: wait and retry. Answered by the gateway, so the body may differ.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

500

Ours: retry, and tell us if it persists.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

503

Momentarily unavailable: retry in a few seconds.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}