Test a webhook subscription
test_webhook_subscriptionSend a signed sample event to a webhook subscription to verify delivery, with a preview first and confirmation required before sending.
Instructions
Send one signed sample event to a subscription now, with the keys of the real event and test: true. ok is true when the destination answered with a status below 400 (a redirect counts as delivered). Logged as a test delivery: never retried and never counted towards disabling the subscription. 409 subscription_disabled or blocked_url; 400 invalid_event when event is not one of the subscription's events. Not generally available yet: until webhook subscriptions are switched on for the account, every call answers 503 with reason webhook_subscriptions_disabled (the feature is off, not a temporary failure). Needs the user's approval: call it first without confirmed to get a preview (nothing is sent), show the user exactly what will go out, and repeat the call with confirmed: true only after they approve.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"subscription_id": "<subscription_id>"
},
"name": "test_webhook_subscription"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| event | No | Which of the subscription's events to sample. Default: its first event. | |
| confirmed | No | Set to true only after the user has seen the preview this tool returns without it and approved it. Without it nothing is sent. | |
| subscription_id | Yes | Subscription id (`whsub_...`) from list_webhook_subscriptions or create_webhook_subscription. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | No |