Webhooks

Delivering Data with a Webhook

POST is our preferred method when delivering data via webhook.

Objects and data sent via webhooks by the API are in snake_case.

Examples

Voice API webhooks

  • conversation_uuid
  • start_time

Messages API callbacks

  • message_uuid
  • timestamp

Webhooks to Fetch Data

There may be some use cases when the webhook fetches data and causes no effect on the receiving side. In this case, GET method may be used and camelCase variables may be preferred for consistency with other parts of the application.

Examples

Nexmo Call Control Objects (NCCO) examples:

  • eventUrl
  • musicOnHold
  • beepOnStart

Why did we choose this?

Pre-existing standard

N/A