Set or remove the account's webhook

Sets (or replaces) the target URL and the events you subscribe to. The response also includes the signing secret - save it right away, GET won't return it again later. An empty events: [] means subscribe to every event, not none - including ones added later. If you only want some events, list them. Conversely, an empty url: "" cancels the webhook - volai then sends nothing, and the response returns url: null. How to verify the signature is covered on the Webhooks.

put/v1/webhook

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/webhook
  • Auth: HTTP bearer

Request body

urlstring required

Public HTTPS callback URL. An empty string removes the webhook. Verify the signature using the secret returned by this request.

eventsstring[]

Complete list of event names to subscribe to. Omit or send [] to subscribe to all events, including future additions. message.sent reports carrier acceptance, not delivery to the recipient. message.received delivers a message received on your SMS number.

Response

Webhook config

urlstring nullable required
eventsstring[] required
secretstring

Changes

No recorded changes to this operation across all 1 revision of this API.