Skip to main content
POST
Register a webhook endpoint
Registers an endpoint and returns its signing secretonce. There is no endpoint that reads it back; if you lose it, rotate. The URL must be publicly routable HTTPS. Anything resolving to a private, loopback, link-local or CGNAT address is rejected here and re-checked before every send, because DNS can be re-pointed after registration. Maximum 5 endpoints per account. Verify the signature as shown in the Webhooks guide. Authentication required. Send your key as Authorization: Bearer csb_pub_.... A read key is enough — managing webhooks moves no money.

Authorizations

Authorization
string
header
required

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile.

Body

application/json
url
string<uri>
required

Public HTTPS endpoint that will receive POSTs.

events
enum<string>[]

Omit or leave empty to receive every event type.

Available options:
order.updated,
webhook.test
description
string

Your own label, e.g. prod or staging.

Maximum string length: 200

Response

Created. secret is shown only here.

data
object