POST/api/partner/v1/webhooks

Create webhook

url must be a public HTTPS address. events omitted = all. The response carries the signing secret ONCE — store it. Events start from now; history stays on the read endpoints. At most 5 endpoints per key. An integration's endpoint receives the events of every connected owner.

Authorization

X-Api-Key header

Send your partner key on every request. The key is bound to exactly one owner account.

Body

application/json

urlstringrequired

Public HTTPS endpoint.

eventsstring[]

Omit (or ["*"]) for all.

Response

200 · application/json

successbooleanrequired

dataobject

idstring

urlstring

eventsstring[]

activeboolean

False once paused after repeated failures

secretstringnullable

Signing secret — returned on create only.

createdAtUtcstring <date-time>

lastSuccessAtUtcstring <date-time>nullable

consecutiveFailuresinteger

lastErrorstringnullable

errorstringnullable

Status codes

200Created (secret included).

400Validation error.

401Missing, unknown or revoked API key.

409The per-key limit of endpoints is reached.