Skip to main content
POST
Create webhook subscription

Authorizations

Authorization
string
header
required

Send a Blinq API key as Authorization: Bearer <api-key>; enter only the key in the documentation playground.

Create and revoke keys in the Blinq web app under Settings > API keys. See Creating and revoking keys above.

The key needs the scopes required by the operation, and public API access requires a Pro or Business plan.

Path Parameters

workspace_id
string
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.

Minimum string length: 1

Body

application/json
url
string
required

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

Required string length: 1 - 2048
events
enum<string>[]
required

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

Minimum array length: 1

An event the subscription receives. contact.created fires when a contact is created in your personal workspace, or once for each new business contact shared into a business workspace. Business payloads carry the business contact id returned by the list contacts endpoint.

Available options:
contact.created

Response

The identity of the newly stored subscription.

The identity of the newly stored subscription.

id
string
required

The created subscription ID.

signing_secret
string
required

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