Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 1.49 KB

File metadata and controls

15 lines (12 loc) · 1.49 KB

# CreateWebhookSettingsRequest

Properties

Name Type Description Notes
name string Webhook name (1-50 characters)
url string Webhook endpoint URL (must be a valid URL, whitespace trimmed)
secret string Secret key for HMAC-SHA256 signature verification [optional]
events string[] Events to subscribe to (at least one required)
is_active bool Enable or disable webhook delivery. Defaults to `true` when omitted. [optional] [default to true]
custom_headers array<string,string> Custom headers to include in webhook requests [optional]
disabled_resource_groups string[] Resource groups this subscription does not receive (opt-out denylist). Omit or send an empty array to receive every event in `events`. Listing a group here drops its events before delivery and on every replay path. Set at creation it applies to everything this subscription ever receives; changed later via PUT it applies to events emitted after the change, with a five-minute tail for events already queued (see that operation). When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned into whatever you send here, so a restricted key can never create a subscription wider than itself. [optional]

[Back to Model list] [Back to API list] [Back to README]