Skip to main content
POST
Test a webhook
  • 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.
  • Callers: an API key, an MCP OAuth token or a Dashboard session.
  • Permission: jobs:read.
  • Effect: Creates or changes something.
  • Errors: not_found, webhook_secret_unreadable, webhooks_unavailable, and the errors any request can get.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

a webhook ID: wh_ and 32 lowercase hex digits

Example:

"wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

Response

How the receiver answered

delivered
boolean
required

The receiver answered with a 2xx

status
integer | null
required

The receiver's HTTP status, or null when none answered

failure
enum<string> | null
required

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

Available options:
invalid_url,
forbidden_address,
timeout,
unreachable