Voice Platform APIWebhook configuration

Update webhook delivery URL

View as Markdown

Temporary endpoint. A complete API for managing applications, phone numbers, tokens, and other settings will replace it. Updates the webhook URL for the authenticated application only. Set webhook_url to null or an empty string to disable delivery. The new setting applies to webhook deliveries created after this request succeeds.

Authentication

AuthorizationBearer
Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>`, where `<app_uuid>` is the provisioned identifier (`app_` + lowercase v4 UUID) and `<api_key>` is the application API key. The two are joined by a single colon (the API key contains no colon). This is the ONLY application auth mechanism. A missing Authorization header or malformed Bearer credential returns `400 invalid_request`; a syntactically valid credential with an invalid API key returns `401 unauthorized`.

Request

This endpoint expects an object.
webhook_urlstring or nullRequired
Webhook delivery URL. Set to null or an empty string to disable webhook delivery. HTTPS is required unless the operator has explicitly enabled HTTP webhooks.

Response

Webhook configuration saved
webhook_urlstring or null
Webhook delivery URL, or null when webhook delivery is disabled.

Errors

400
Bad Request Error
401
Unauthorized Error
413
Content Too Large Error
415
Unsupported Media Type Error
500
Internal Server Error
503
Service Unavailable Error