Endpoints to manage tenant-specific configurations and webhooks.
Get webhook configuration for a tenant
Get webhook configuration for a tenant
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Webhook configuration retrieved successfully
idstring · uuidtenant_idstring · uuidtriggered_eventstringfieldsstring[]urlstring · urihttp_methodstringsecretstringis_activebooleancreated_atstring · date-timeupdated_atstring · date-time
Create or update a webhook URL for a tenant
Create or update a webhook URL for a tenant
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
tenant_idstring · uuid · requiredID of the tenant
triggered_eventstring · enum · requiredEvent that triggers the webhook
Enum values:call_activityapplication_activtytypestring · enum · requiredType of webhook
Enum values:post_call_screeningfieldsstring[] · requiredFields to include in the webhook payload
urlstring · uri · requiredURL where webhook notifications will be sent
http_methodstring · enum · requiredHTTP method to use for the webhook request
Enum values:POSTPUTPATCHcontent_typestring · enum · requiredContent type of the webhook payload
Enum values:application/jsonapplication/x-www-form-urlencoded
secretstringSecret key used to sign webhook payloads
is_activebooleanWhether the webhook is active
Responses
Webhook created or updated successfully
idstring · uuidtenant_idstring · uuidtriggered_eventstringtypestringfieldsstring[]urlstring · urihttp_methodstringcontent_typestringsecretstringis_activebooleancreated_atstring · date-timeupdated_atstring · date-time
Subscribe to a tenant webhook
Subscribe to a tenant webhook by setting is_deleted to false
path Parameters
tenant_webhook_idstring · uuid · requiredID of the webhook
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Webhook subscribed successfully
messagestring
Unsubscribe from a tenant webhook
Unsubscribe from a tenant webhook by setting is_deleted to true
path Parameters
tenant_webhook_idstring · uuid · requiredID of the webhook
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Webhook unsubscribed successfully
messagestring