Webhooks

Create webhook subscription

Available to any API-eligible account with a verified email address.

Stores a webhook subscription for your personal workspace or for a business workspace where you are an owner or admin. Business members and other workspaces return 404. Business subscriptions belong to the workspace, not to the key owner, so other owners and admins can list and delete them.

In a business workspace, contact.created fires once for each new business contact shared into that workspace. Its data.contact_id is the business contact id returned by the list contacts endpoint. Updates, repeat shares, restores, and imported or backfilled history do not fire it, and events from before the subscription was created are not replayed.

The URL must be an absolute HTTPS URL without embedded credentials or a fragment. At least one event is required, and duplicate event names are stored once. No request is sent to the URL during registration.

Repeated calls create separate subscriptions, including for the same URL. Store the signing_secret returned on creation securely; it cannot be retrieved again. If the response is lost, delete the subscription and create a replacement.

Requires the blinq:webhooks:write and blinq:contacts:read scopes.

post/v1/workspaces/{workspace_id}/webhooks

Request

  • Base URL
    https://api.blinq.me
  • Auth
    HTTP bearer

Path parameters

workspace_idstring required

The workspace ID: your individual workspace, or a business workspace where you are an owner or admin. Use an id returned by the list workspaces endpoint.

Request body

urlstring required

The HTTPS destination URL for deliveries. Credentials and fragments are rejected. The stored URL is the normalized form, preserving query parameters.

eventsstring[] required

The events to receive. At least one is required; duplicates are stored once.

Response

The identity of the newly stored subscription.

idstring required

The created subscription ID.

signing_secretstring required

Store this signing secret securely. It is returned only on creation and cannot be retrieved again.

Changes

No recorded changes to this operation across all 1 revision of this API.