Skip to main content
POST
Create or rotate the webhook subscription for this environment
Agents: fetch this page as plain markdown at https://docs.usecleff.com/api-reference/webhook-subscriptions-create.md.

Authorizations

Authorization
string
header
required

Cleff API key, created in the dashboard under Settings → API keys

Body

application/json
url
string
required
Example:

"https://api.example.com/cleff/webhooks"

enabled_events
enum<string>[]
required

Opt-in allowlist of event types to receive. Only values from this enum are accepted; a value outside it is rejected on this request.

Available options:
payout.disbursement_submitted,
payout.acknowledged,
payout.estimated_arrival_at,
payout.disbursed,
payout.delivered,
payout.settled,
payout.canceled,
payout.failed,
payout.returned,
payout.rejected,
beneficiary.details_submitted,
beneficiary.bank_account.registered,
beneficiary.enrollment_rejected
Example:

Response

subscription
object
required
secret
string
required

Signing secret. Shown ONCE at creation (and on rotation). Cleff cannot recover it later.

Example:

"whsec_sandbox_F2x…"