Skip to main content
POST
Register a webhook endpoint

Authorizations

X-Api-Key
string
header
required

Your API key, e.g. kua_live_… (or kua_test_… in test mode).

Body

application/json
url
string
required
description
null | string
required
eventTypes
null | string
required

Response

Created

A registered webhook endpoint. The signing secret is present only on the create response — it can't be retrieved again.

id
string<uuid>
required

The endpoint's unique id.

url
string
required

The URL Kua will POST events to.

description
null | string
required

Your label for this endpoint.

eventTypes
string
required

Comma-separated event types, or * for all.

isActive
boolean
required

Whether the endpoint is currently receiving events.

secret
string
required

The signing secret (whsec_…). Shown once — store it now.