webhooks

Test a webhook

Send a signed test event to one of your webhooks and report how its receiver responded.

  • It is sent now, whether the webhook is active or not.
  • The event is {"id", "type": "webhook.test", "created_at", "data": {"webhook_id"}}.
  • It is not retried and does not count toward turning the webhook off.
post/v1/webhooks/{id}/test

Request

  • Base URL: https://api.pomerado.ai
  • URL: https://api.pomerado.ai/v1/webhooks/{id}/test
  • Auth: HTTP bearer

Path parameters

idstring required
Example:wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190

a webhook ID: wh_ and 32 lowercase hex digits

Response

How the receiver answered

deliveredboolean required

The receiver answered with a 2xx

statusinteger required

an integer

failure'invalid_url' | 'forbidden_address' | 'timeout' | 'unreachable' nullable required

Why no receiver answered: forbidden_address when the URL resolves to a private address, timeout after 10 seconds, or unreachable

Changes

No recorded changes to this operation across all 2 revisions of this API.