Send a test event to a webhook endpoint

POST

/api/v1/workspaces/{workspaceId}/webhook-endpoints/{endpointId}/test

const url = 'https://api.crossmart.io/api/v1/workspaces/example/webhook-endpoints/example/test';
const options = {method: 'POST', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.crossmart.io/api/v1/workspaces/example/webhook-endpoints/example/test \
  --header 'x-api-key: <x-api-key>'

A webhook.test event, to this endpoint only and tried once. Its outcome shows in the delivery log within seconds.

Authorizations

api_key
cookie
bearer

Parameters

Path Parameters

workspaceId

required

string

endpointId

required

string

Responses

202

application/json

object

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

Example

{
  "eventType": "order.created",
  "status": "PENDING"
}