Skip to main content
POST
Create a webhook subscription

Authorizations

x-api-key
string
header
required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Body

application/json
url
string
required

Public https URL to deliver events to.

events
string[]
required

Event names from GET /v1/webhook-events.

description
string

Response

Created. secret is shown only here.

success
enum<boolean>
Available options:
true
data
object
meta
object