Webhooks

curl -X GET "/v1/webhooks"

Run the request to inspect the response.

curl -X POST "/v1/webhooks" -H "Content-Type: application/json" -d '{
  "url": "https://example.com"
}'

Run the request to inspect the response.

curl -X GET "/v1/webhooks/{id}"

Run the request to inspect the response.

curl -X PATCH "/v1/webhooks/{id}" -H "Content-Type: application/json" -d '{
  "url": "https://example.com"
}'

Run the request to inspect the response.

curl -X DELETE "/v1/webhooks/{id}"

Run the request to inspect the response.

The Webhooks API manages your subscriptions. The actual delivery contract — signing, idempotency and the trigger catalog — lives in Webhooks → the guide. This page is the endpoint-by-endpoint reference.

Endpoints

Method	Path	Scope
GET	/v1/webhooks	webhooks.read
POST	/v1/webhooks	webhooks.write
GET	/v1/webhooks/{id}	webhooks.read
PATCH	/v1/webhooks/{id}	webhooks.write
DELETE	/v1/webhooks/{id}	webhooks.write

Create a subscription

1
curl -X POST https://api.webmoment.app/v1/webhooks \
2
  -H "Authorization: Bearer $WEBMOMENT_TOKEN" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
    "name": "Production listener",
6
    "url": "https://api.example.com/webhooks/webmoment",
7
    "secret": "whsec_…",
8
    "triggers": ["timeline.created", "moment.created", "moment.updated",
9
                 "moment.completed", "moment.failed", "collection.created", "tracking.created",
10
                 "quota.moments.75_percent_reached", "workspace.member.added"]
11
  }'
12
 

The secret is required if you don't want to receive X-Webmoment-Signature: "". We strongly recommend ≥ 32 bytes of entropy. The response is the new Webhook row, including its id and disabledAt (always null on creation).

Spec

The full request and response shapes are in the OpenAPI spec at /api/v1/openapi — see the Webhooks tag and the createWebhookSchema, updateWebhookSchema, and WebhookSchema components.