Webhook endpoints

Send a test event

Delivers a sample event to the endpoint right now, once, and reports what came back. If it can't be sent from here straight away, outcome is pending and response_status is null: the delivery is queued and goes out within five minutes, and its result appears in the delivery log. The delivery lands in the log like any other, so you can see exactly what was sent, and it carries both signature schemes.

Scope: webhooks:write (or write)

post/v1/webhook_endpoints/{id}/ping

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/webhook_endpoints/{id}/ping
  • Auth: HTTP bearer

Path parameters

idstring required

Prefixed id (whe_…)

Example:whe_7uSyy9FqVLCFWrdPeZaK

Request body

event_typestring

Any type from the event catalogue. Defaults to sale.created.

Response

What the one attempt did

object'webhook_ping' required
delivery_idstring required
outcomestring required
response_statusinteger nullable required

Changes

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