Sign in
Webhooks

Trigger a webhook test delivery

Send a one-time test webhook notification payload to a target HTTPS URL without creating a webhook endpoint. For 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

Request body

urlstring uri required

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

eventstring required

Webhook event name to use for generating an example payload.

secretstring

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

Example request

{
  "url": "https://webhook.site/your-endpoint",
  "event": "tracking_request.succeeded",
  "secret": "optional-test-secret",
  "sample": {
    "document_type": "dray_delivery_order"
  }
}

Response

Webhook test delivery attempt result

urlstring uri

Destination URL that the test webhook delivery attempted to call.

succeededboolean

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

errorstring nullable

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

status_codeinteger nullable

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

request_headersobject

Headers sent by Terminal49 with the test webhook request.

request_bodystring

Serialized JSON payload delivered to the target URL.

response_headersobject nullable

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

response_bodystring nullable

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

Changes