Skip to main content
PATCH
Update webhook

Authorizations

Authorization
string
header
required

Organisation API key created in Assess → Developer → API Keys. Format: Bearer ct_live_<your-key> (live) or Bearer ct_test_<your-key> (test). Optional per-key CIDR allowlists return 403 IP_NOT_ALLOWED.

Path Parameters

id
string<uuid>
required

Body

name
string

Display name for this destination. Auto-generated if left blank.

Maximum string length: 80
kind
enum<string>

https = signed JSON. slack/teams = chat message (OAuth or Incoming Webhook).

Available options:
https,
slack,
teams
url
string
slack_channel_id
string
Maximum string length: 32
slack_channel_name
string
Maximum string length: 80
is_active
boolean
events
any

List of event types this webhook subscribes to.

Response

id
string<uuid>
required
name
string
required
kind
enum<string>
required
Available options:
https,
slack,
teams
url
string
required
display_target
string
required
slack_channel_id
string
required
slack_channel_name
string
required
slack_team_name
string | null
required
secret_key
string
required
is_active
boolean
required
is_verified
boolean
required
events
string[]
required
created_at
string<date-time>
required
last_triggered_at
string<date-time> | null
required
failure_count
integer
required
probe_consecutive_failures
integer
required
auto_paused_by_health
boolean
required
pending_delivery_count
integer
required
Last modified on September 5, 2026