List webhook events that were not delivered

GET

/order/v1/webhook/events

• Sandbox

Returns a paginated list of webhook events for the authenticated company that failed to be delivered.

Authorizations

• Bearer

Parameters

Query Parameters

limit

number

default: 20 >= 1 <= 5000

Maximum number of items returned in the current page (default 20, max 5000)

sort

string

default: desc

Allowed values: asc desc

Direction of the sort (default: desc)

cursor

string

Cursor used for pagination. Omit this field in the first request. For subsequent requests, set it to the nextCursor value returned in the previous response.

from

string

Only return events created at or after this ISO date

to

string

Only return events created at or before this ISO date

Responses

200

The resource was returned successfully

object

limit

The maximum number of records returned in the current page. Corresponds to the limit value provided in the request.

number

Example

20

sort

Defines the sorting direction applied to the results. Allowed values: “asc” — ascending order, “desc” — descending order (default)

string

Allowed values: asc desc

Example

desc

nextCursor

A cursor value representing the timestamp of the last item returned in the current page. This value must be provided as the cursor parameter in the next request to continue retrieving results.

string

Example

2025-01-01T10:00:00Z

hasNext

required

Indicates whether additional pages of data are available.

boolean

Example

true

data

required

The webhook events that failed to be delivered

Array<object>

object

id

required

The id of the webhook event

string

referenceId

The reference id of the event (e.g. order id)

string

webhookUrl

required

The URL the webhook was sent to

string

status

required

The current delivery status

string

createdAt

required

When the event was created

string

updatedAt

When the event was last updated

string

history

required

The delivery attempt history for this event

Array<object>

object

message

required

The message returned by the partner endpoint

string

statusCode

required

The HTTP status code returned by the partner endpoint

number

requestTime

required

When this delivery attempt was made

string

400

object

error

string

Example

INVALID_REQUEST

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

403

object

error

string

Example

FORBIDDEN_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]