Webhooks API

Webhooks API Webhooks let the platform notify your other systems the moment something happens — a new contact, a reply, an appointment booked, and more. This API manages the subscriptions themselves: which URLs receive which events. For how to receive and verify the payloads your endpoint gets, see Webhooks . All paths below are relative to the API base URL: https://api.relaytiv.com/v1 Every request must be authenticated. See Authentication for the four accepted methods. The examples here use the X-API-Key header (and one query-parameter form for cURL). 📝 Note: Webhooks must be enabled for your account. If they are not, these endpoints return a 403 . How subscriptions are addressed Each subscription has an id and an optional name . Either one can be used as the {webhookId} in the path for update, delete, test, health, and re-enable. Prefer the name. Subscription ids are positional, so they can shift after another subscription is deleted. If you set a stable name when creating a subscription, address it by name to avoid surprises. List subscriptions GET /webhooks cURL curl "https://api.relaytiv.com/v1/webhooks?apiKey=YOUR_API_KEY" JavaScript const res = await fetch("https://api.relaytiv.com/v1/webhooks", { headers: { "X-API-Key": "YOUR_API_KEY" }, }); const data = await res.json(); Python import requests res = requests.get( "https://api.relaytiv.com/v1/webhooks", headers={"X-API-Key": "YOUR_API_KEY"}, ) data = res.json() Response { "success": true, "webhooks": [ { "id": "0",