Skip to main content
POST
Webhook endpoints let your platform receive event notifications from Hop over HTTPS. Webhook endpoints are customer-level resources, addressed under the owning customer (/customers/{customer_id}/webhook-endpoints) — consistent with accounts and agreements. You register an endpoint with a delivery URL and a filter of event types; Hop signs every delivery with the endpoint’s signing secret. Webhook endpoints are addressed by an id with the wh_ prefix. Registers a webhook endpoint with a delivery URL and a list of subscribed event types.

​
Path Parameters

​
string
required
Id of the owning customer (cus_…).

​
Request Body

​
string (HttpUrl)
required
HTTPS URL that will receive event deliveries.
​
string[]
required
Event types to subscribe to. At least one entry; each value is validated against the subscribable event catalog.
​
string | null
Free-text label for the endpoint. Maximum 255 characters.

​
Response

Returns 200 with the new endpoint’s id and its signing secret.
​
string
Id of the endpoint (wh_…).
​
string
Signing secret used to verify webhook deliveries.
Store the secret now. The full secret is returned only on create — it cannot be retrieved again later.