Webhooks

Send a test event

Sends one signed test event with a single sample contract to the registered url, using the same headers, signature, timeout and retry policy as real deliveries, and reports the outcome synchronously (the request can take up to ~25 s if every attempt times out). A successful test resumes a paused webhook and resets consecutive_failures; a failed test does not count towards the pause threshold. The test delivery is recorded in GET /webhooks/{id}/deliveries.

Answers 200 when a 2xx was received and 502 when it was not - both with the same body shape.

post/webhooks/{id}/test

Request

  • Base URL: https://optionsbell.com/api/v1
  • URL: https://optionsbell.com/api/v1/webhooks/{id}/test
  • Auth: API key in header X-API-Key

Response

Delivered (delivered: true).

deliveredboolean required
delivery_idstring required
attemptsinteger required
http_statusinteger nullable required
duration_msinteger required
errorstring nullable required

Example response

{
  "delivery_id": "whd_3f9c1a2b4d5e6f708192a3b4"
}

Changes

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