Webhooks

Subscribe webhook to a workspace

Subscribe a webhook URL to receive events for every link in the workspace. A new subscription receives a POST for each click, link.created, link.updated, and link.deleted; the events can be narrowed per URL in the workspace settings. Branch on the JSON event field; see the Webhooks section for payload shapes.

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

Request

Base URL
https://api.linklyhq.com
Auth
API key in query parameter api_key
TypeScript
https://skmtc.dev/linklyhq/apis/linkly-url-shortener-api/docs/api/v1/workspace/:workspace_id/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

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/"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.