Skip to content
Crossmart Docs

One delivery, with the JSON body it sends

GET
/api/v1/workspaces/{workspaceId}/webhook-endpoints/{endpointId}/deliveries/{deliveryId}
curl --request GET \
  --url https://api.crossmart.io/api/v1/workspaces/example/webhook-endpoints/example/deliveries/example \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
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
payload
required

The JSON body every attempt sends

object
id
required

The event id: deduplicate on it

string format: uuid
type
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
createdAt
required

When the change happened

string
workspaceId
required
string format: uuid
apiVersion
required
string
data
required

The event’s data; its shape depends on the type

object
key
additional properties
any

Example 

{
  "eventType": "order.created",
  "status": "PENDING",
  "payload": {
    "type": "order.created",
    "apiVersion": "v1"
  }
}