Skip to main content
POST
Registers a new webhook partner for the authenticated instance. Returns an API key and webhook secret used to authenticate incoming webhook deliveries. The webhook URL must use HTTPS.

Request Body

string
required
Display name for this webhook integration. Maximum 100 characters.
string
required
HTTPS URL where events will be delivered.

Response Fields

boolean
Request status.
object
The apiKey and webhookSecret are only returned once at registration time. Store them securely.