Skip to main content
POST
Create an event subscription

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
url
string
required

HTTPS endpoint the events are POSTed to. Checked for SSRF at write time; delivery re-checks at send time.

Maximum string length: 2048
event_types
string[]
required
Required array length: 1 - 100 elements
Required string length: 1 - 64
description
string | null
Maximum string length: 500

Response

201 - application/json

Default Response

uuid
string
required
url
string
required

HTTPS endpoint the events are POSTed to. Checked for SSRF at write time; delivery re-checks at send time.

Maximum string length: 2048
event_types
string[]
required

Event types to subscribe to. Each entry is an exact v2 event type (e.g. lead.status_changed) or a trailing wildcard segment naming an object (e.g. lead.* for every lead type). See GET /v1/event-types for the catalogue.

status
enum<string>
required

paused stops delivery without deleting the subscription.

Available options:
active,
paused
version
number
required

Envelope schema version delivered to this endpoint. Always 2 from /v1; immutable.

description
string | null
required
Maximum string length: 500
secret_hint
string
required

Last four characters of the signing secret, for identification only. The full secret is returned once, in the POST response.

created_at
string
required
updated_at
string
required
secret
string

The signing secret for this subscription's deliveries. Returned only on the first response — an Idempotency-Key replay returns the same subscription with secret omitted. Store it now; it is never returned again.