Send a signed `integrations.webhook.test` event through the normal delivery path
POST/v1/webhooks/:webhook_id:test
Sends a fixed test payload (none of your data), signed and recorded like every delivery (is_test: true). It works on a disabled endpoint, so you can check a fix before you turn the endpoint back on, and it never counts towards automatic disabling. At most 10 test events per endpoint per hour.
Access: API key scope webhooks:write on a management key; portal users: organization admins and owners; refused for an API key limited to a list of knowledge bases (403 kb_not_in_allowlist); refused with 403 integrations_disabled while webhooks are switched off for the platform or your organization.
Request
Responses
- 202
- 403
- 404
- 429
Queued; the delivery appears in the delivery list.
scope_missing (details.required_scope), role_insufficient, kb_not_in_allowlist, integrations_disabled (details.area, details.scope), domain_blocked.
not_found — identical for missing resources and resources of another organization (details.resource).
rate_limited, webhook_test_rate_limited, verification_rate_limited (with Retry-After and retry_after_seconds).