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
Create a tenant and provision an API key
Creates a tenant via the superadmin service and provisions a Zuplo API key for that tenant. Returns the generated API key.
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_namestring · requiredDisplay name of the tenant. The tenant's API key is named
<parent tenant name>-<tenant_name>, so the name must not already have an API key under the parent (409 TENANT_NAME_TAKEN).emailstring · email · requiredEmail of the tenant's primary admin user
first_namestring · requiredFirst name of the tenant's primary admin user
passwordstringOptional. Password for the tenant's primary admin user.
subdomainstringOptional. Subdomain for the tenant. Falls back to the lowercased tenant_name if omitted; if explicitly provided it must be unique (409 otherwise).
scheduling_enabledbooleanOptional. Whether scheduling is enabled for the tenant.
email_enabledbooleanOptional. Whether email is enabled for the tenant.
sms_enabledbooleanOptional. Whether SMS is enabled for the tenant. Defaults to true if omitted.
Responses
Tenant created and API key provisioned
tenantobjectRaw response from the superadmin create-tenant service
consumerobjectapiKeystringThe provisioned API key for the tenant
apiKeyIdstringtenant_idstring · uuidPass this tenant id to DELETE /v1/superadmin/tenants/{tenant_id}/api-keys to revoke the key.
subdomainstringThe tenant's subdomain: the request's
subdomain, or the lowercasedtenant_name.consumer_namestringName of the tenant's API key consumer in Zuplo:
<parent tenant name>-<tenant_name>.
Revoke a tenant's API keys
Revokes every API key provisioned for the tenant by POST /v1/superadmin/tenants, found by the tenant_id in its consumer metadata. Superadmin only, and only for tenants created under the caller's own tenant.
path Parameters
tenant_idstring · uuid · requiredID of the tenant whose API keys are revoked, as returned by the create call.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
API keys revoked. Revoking a tenant with no keys left succeeds with revoked_count 0.
subdomainstringtenant_idstringrevoked_countintegerrevoked_api_key_idsstring[]