Create a webhook endpoint

POST /v1/webhook-endpoints

Scope: webhooks:manage · Idempotency-Key: not accepted

string

required

An https:// URL that resolves to a public address. Loopback, link-local and private addresses are refused.

string[]

required

At least one event type from the catalog, or ["*"] for all.

string

A note for your team.

curl -X POST https://api.stg.cleo-pay.com/v1/webhook-endpoints \
  --header "Authorization: Bearer $CLEO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "url": "https://hooks.example.com/cleo",
    "subscribedEventTypes": ["payment.held", "payment.completed", "payment.failed", "payment.returned", "invoice.paid"],
    "description": "Production payments listener"
  }'

Response

201 with the endpoint and its secret (whsec_...). This is the only time the full secret is returned; afterwards only secretLast4 is shown. Store it as a credential. The route takes no Idempotency-Key, because a replay would have to store and return the secret again. If a create times out, call GET /v1/webhook-endpoints before you create another.

Business

Payables

Payments

Contacts

Invoices

Balance

Bank Accounts

Webhook Endpoints

Create a webhook endpoint

Response

​Response

Response