Skip to content
Crossmart Docs

The delivery log of a webhook endpoint, newest first

GET
/api/v1/workspaces/{workspaceId}/webhook-endpoints/{endpointId}/deliveries
curl --request GET \
  --url 'https://api.crossmart.io/api/v1/workspaces/example/webhook-endpoints/example/deliveries?status=PENDING&eventType=order.created&direction=desc&limit=25' \
  --header 'x-api-key: <x-api-key>'

Deliveries are kept for 30 days.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string
endpointId
required
string

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: PENDING RETRYING SUCCEEDED FAILED
eventType
string
Allowed values: order.created order.updated inventory.stock_changed listing.published listing.failed listing.removed product.created product.updated product.deleted webhook.test
direction
string
Allowed values: asc desc
cursor
string format: uuid

nextCursor from the previous page

page
number
>= 1

1-based page number, for tables with page numbers. It wins over cursor.

limit
number
default: 25 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
items
required
Array<object>
object
id
required

Sent as the Crossmart-Delivery-Id header

string format: uuid
endpointId
required
string format: uuid
eventId
required

The event id; the same on every redelivery

string format: uuid
eventType
required
string
Allowed values: order.created order.updated inventory.stock_changed listing.published listing.failed listing.removed product.created product.updated product.deleted webhook.test
status
required

RETRYING: an attempt failed and another is scheduled at nextAttemptAt

string
Allowed values: PENDING RETRYING SUCCEEDED FAILED
attempts
required

Attempts made so far

number
responseStatus
required

HTTP status of the latest attempt

number
nullable
durationMs
required
number
nullable
error
required

Why the latest attempt failed

string
nullable
nextAttemptAt
required
string format: date-time
nullable
lastAttemptAt
required
string format: date-time
nullable
deliveredAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
nextCursor
required
string
nullable
total
required
number

Example 

{
  "items": [
    {
      "eventType": "order.created",
      "status": "PENDING"
    }
  ]
}