Sign in
latestOpenAPI 3.0.02026-08-202629123.8 KB

351c1f004617

Webhooks

Subscribe webhook to a workspace

Subscribe a webhook URL to receive events for every link in the workspace. The endpoint receives a POST for each click, link.created, link.updated, and link.deleted. Branch on the JSON event field; see the Webhooks section for payload shapes.

post/api/v1/workspace/{workspace_id}/webhooks

Path parameters

workspace_idinteger required

The ID of the workspace to subscribe to

Request body

urlstring uri required

The webhook URL to receive click notifications

Example request

{
  "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/"
}

Response

Webhook subscribed

idstring

The webhook URL (used as the hook ID for unsubscribing)

Example response

{
  "id": "https://hooks.zapier.com/hooks/catch/123456/abcdef/"
}