Contents

API reference / Webhooks

Update a webhook

PATCH /api/v1/webhooks/{webhook}

update_webhook Write MCP tool

Turning a webhook back on (enabled: true) clears its failure count and the reason it was turned off.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

NameTypeDescription
webhook required
path
 string The webhook's id.

Request body

JSON, sent with Content-Type: application/json.

NameTypeDescription
url string
8–2048 characters
 Where to POST events. Must be a public https:// URL.
events array of string
up to 50 items
 Event types to send, or ["*"] for all (the default). GET /v1/webhook-events lists them.
project_id string or null Only events from this project; null for the whole workspace.
description string or null
up to 500 characters
 A note for yourself, e.g. what receives it.
enabled boolean false stops deliveries; true resumes them.

Returns

Webhook

Example

curl -X PATCH "https://sniffington.com/api/v1/webhooks/{webhook}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/social-scout","events":["…"]}'