Webhook endpoints

Send a test event

Send a signed webhook.test event to the endpoint.

post/api/v1/webhook-endpoints/{endpoint_id}/test

Request

  • Base URL: https://api.sudomock.com
  • URL: https://api.sudomock.com/api/v1/webhook-endpoints/{endpoint_id}/test
  • Auth: API key in header x-api-key

Path parameters

endpoint_idstring required

Id of the endpoint the test event is sent to.

Response

Successful Response

statusstring required

Confirms the test event was accepted and is on its way to your endpoint.

event_typestring required

Event type the test carries, so your handler can tell it apart from real traffic.

job_idstring required

Identifier this test event is raised for, which you can match against the delivery log.

Example response

{
  "event_type": "webhook.test",
  "job_id": "4a4bfe21-d9d2-43a4-9877-b6ca4aec4349",
  "status": "enqueued"
}

Changes

No recorded changes to this operation across all 1 revision of this API.