Skip to main content
POST
Test webhook

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Webhook sid (wh_hk_…).

Required string length: 18
Pattern: ^wh_hk_

Body

application/json

Request body of test_webhook.

override_event_type
string

Test with a specific event type payload shape (default: webhooks.test synthetic).

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required
credits
object