Skip to main content
POST
This endpoint sends one monitor.webhook.test event to the current webhook URL, signed with the current secrets. It takes no request body and returns after the receiver responds or the 10-second attempt times out. HTTP 200 means the test completed, not necessarily that delivery succeeded. Check delivered, status_code when available, and error for the outcome. When delivery fails, error is a typed string such as http_status, timeout, network_error, or tls_certificate. An http_status error includes the receiver’s status_code; redirects count as failures. Allow for new error values. A delivered test omits error. The attempt is not retried and does not count toward the webhook_failing pause threshold. A monitor without a webhook returns HTTP 409 with invalid_state; add a webhook before testing.

Authorizations

Authorization
string
header
required

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

Path Parameters

monitor_id
string
required

Monitor identifier (mon_...)

Response

The outcome of the send, delivered or not

The outcome of one test send

object
enum<string>
required
Available options:
monitor.webhook_test
event_id
string
required

The test event's id and webhook-id header

delivered
boolean
required

The receiver answered 2xx

duration_ms
integer<int32>
required

Time from sending to the answer or the failure

Required range: x >= 0
status_code
integer<int32>

The receiver's HTTP status; omitted when it never answered

error
enum<string>

Why the send failed; omitted when delivered. http_status: the receiver answered status_code (a 3xx too, since redirects are not followed). New values may be added.

Available options:
http_status,
timeout,
network_error,
tls_certificate,
blocked_address,
invalid_url,
send_failed