Send a synthetic test event to a webhook

Synchronously dispatches a synthetic test envelope (eventType=webhook.test) to the subscription and returns the delivery result. 404 when the subscription does not exist.

POST /webhooks/{id}/test

Send a synthetic test event to a webhook

cURL

curl --request POST \
  --url https://slc.sandbox.lerian.net/webhooks/{id}/test \
  --header 'Authorization: Bearer <token>'

200

{
  "httpStatus": 123,
  "responseTimeMs": 123,
  "retryable": true,
  "success": true
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Subscription id (UUID).

Example:

"0190b5a0-0000-7000-8000-0000000000aa"

Response

200

application/json

OK

httpStatus · integer<int64> · required

HTTP status code returned by the consumer for the synthetic test delivery.

Example:

200

responseTimeMs · integer<int64> · required

Consumer response time for the synthetic test delivery, in milliseconds.

Example:

142

retryable · boolean · required

Whether a failed synthetic delivery would be retried under the retry policy.

Example:

false

success · boolean · required

Whether the synthetic delivery was classified as successful.

Example:

true