Contents

API reference / Webhooks

Create a webhook

POST /api/v1/webhooks

create_webhook Write MCP tool

Events are POSTed as JSON and signed per Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature headers). The signing secret is in this response only, so store it now.

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

Request body

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

NameTypeDescription
url required 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.

Returns

Webhook & { secret }

Example

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