Webhooks

Receive call results

This endpoint should be implemented by clients to receive call results from Callbook AI. If a callback_url was provided when triggering the call, Callbook AI will send a POST request to it with the following structure.

post/webhook/call_results

Request

  • Base URL: https://api.callbook.ai
  • URL: https://api.callbook.ai/webhook/call_results
  • Auth: none declared

Request body

call_idstring

The unique identifier of the call.

assistant_idstring

The assistant that handled the call.

Example request

{
  "call_id": "call_789456",
  "assistant_id": "assistant_123456",
  "transcription": [
    {
      "speaker": "user",
      "text": "Hello, I need help with my order."
    }
  ],
  "variables": {
    "voicemail": true,
    "call_duration": 45,
    "custom_field_1": "Custom Value",
    "custom_field_2": "Another Value"
  }
}

Response

Webhook received successfully.

phone_numberstring
country_codestring
whole_numberstring
durationinteger
statusstring
audiostring
phonestring
namestring
voicemailstring
user_asked_to_be_called_againstring

Changes

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