Skip to main content

Create Webhook Endpoint

POST 

/webhook-endpoints

Register an HTTPS URL to receive the subscribed event types for brands in the key owner's scope. eventTypes must be non-empty, unique and from the catalogue; webhook.test cannot be subscribed. A user can have at most 10 endpoints. The response carries the signing secret once.

Request and response fields at a glance
  • Request body (application/json): url (string, required), description (string or null), eventTypes (array, required).
  • 201 response (application/json): webhookEndpoint (object, required), secret (string, required).

Request​