Trigger a webhook test delivery

Send a one-time test webhook notification payload to a target HTTPS URL without creating a webhook endpoint. For Wayfair document webhook events (document_representation.created and document_representation.failed), you can pass sample.document_type to test a specific document type payload.

POST /webhooks/trigger

cURL

Trigger webhook test delivery

curl --request POST \
  --url https://api.terminal49.com/v2/webhooks/trigger \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://webhook.site/your-endpoint",
  "event": "tracking_request.succeeded",
  "secret": "optional-test-secret"
}
'

200

{
  "url": "https://webhook.site/your-endpoint",
  "succeeded": true,
  "error": null,
  "status_code": 200,
  "request_headers": {
    "Content-Type": "application/json",
    "User-Agent": "Terminal49 Webhook Bot",
    "X-T49-Webhook-Signature": "abc123"
  },
  "request_body": "webhook notification payload JSON",
  "response_headers": {
    "content-type": "application/json"
  },
  "response_body": "ok"
}

Authorizations

Authorization · string · header · required

Token YOUR_API_TOKEN

The APIs require authentication to be done using header-based API Key and Secret Authentication.

API key and secret are sent va the Authorization request header.

You send your API key and secret in the following way:

Authorization: Token YOUR_API_KEY

Body

application/json

url · string<uri> · required

Destination URL for the test webhook delivery. Must be HTTPS.

Example:

"https://webhook.site/your-endpoint"

event · string · required

Webhook event name to use for generating an example payload.

Example:

"tracking_request.succeeded"

secret · string

Optional secret used to sign the request in X-T49-Webhook-Signature.

Example:

"optional-test-secret"

sample · object

Optional test payload controls. Currently only supports document_type for Wayfair document webhook events.

Show child attributes

Response

200

application/json

Webhook test delivery attempt result

url · string<uri>

Destination URL that the test webhook delivery attempted to call.

succeeded · boolean

Whether the webhook delivery attempt was considered successful (HTTP 200, 201, 202, or 204).

error · string | null

Error message captured when delivery failed, or null when no error occurred.

status_code · integer | null

HTTP status code returned by the destination endpoint, or null if no response was received.

request_headers · object

Headers sent by Terminal49 with the test webhook request.

request_body · string

Serialized JSON payload delivered to the target URL.

response_headers · object

Headers returned by the destination endpoint, or null when unavailable.

response_body · string | null

Raw response body returned by the destination endpoint, or null when unavailable.