Registering a Webhook

Overview
Registration Details
Next Steps

Overview

Contact your account representative to register a webhook endpoint.

Registration Details

You will need to provide the following:

Field	Description	Example
`webhookName`	A name you choose to identify this subscription.	`Order Updates Listener`
`address`	The publicly reachable `https` URL that will receive events.	`https://customerapi.com/receive-webhook`
`topic`	The event type to subscribe to.	`orders/placed`
`subTopics`	The event subtypes to subscribe to.	`["product:adv/adv-120"]`
Tenant ID	The organizational unit that generates the events.	`OU1243`

A registration is described by the following structure:

{
  "webhookName": "Order Updates Listener",
  "address": "https://customerapi.com/receive-webhook",
  "topic": "orders/placed",
  "subTopics": ["product:adv/adv-120"]
}

Next Steps

Once your endpoint is registered, implement it and verify the requests it receives.