Skip to main content
POST
Trigger a webhook test delivery

Authorizations

Authorization
string
header
required

Use a Terminal49 API key in the Authorization header with the Token prefix.

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"

Response

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 | null

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.