webhooks

Server Message

POST

https://api.heycall-e.com

/calle/webhook

CALL-E sends this request to your server when a call reaches a terminal state. Configure this URL with webhook_url on create call or through project-level webhook settings.

Server Message › Headers

CALL-E-Event-Id

string · pattern: ^evt_[A-Za-z0-9_-]+$ · required

Unique webhook event id. Store this value before side effects so duplicate deliveries can be ignored safely.

CALL-E-Timestamp

string · required

Unix timestamp used in the signed payload. Verify this header together with CALL-E-Signature before parsing JSON.

CALL-E-Signature

string · required

HMAC SHA-256 signature in the form v1=<hex digest>, computed over timestamp + "." + raw_body with your webhook secret.

Server Message › Request Body

Event payload CALL-E sends to your webhook receiver.

WebhookEvent

id

string · required

Unique webhook event id. Use it as an idempotency key when processing webhook side effects.

type

WebhookEventType · enum · required

Terminal event type for the call.

Enum values:

call.completed

call.failed

call.result_validation_failed

created_at

string · date-time · required

ISO 8601 timestamp when CALL-E created this webhook event.

WebhookCallData · required

Terminal call task snapshot associated with the webhook event.

Server Message › Responses

Webhook accepted.

Example acknowledgement response from your webhook receiver. CALL-E treats any 2xx response as delivered and ignores the response body.

WebhookAcknowledgement

ok

boolean

Optional acknowledgement flag returned by your server.

POST/calle/webhook

curl https://api.heycall-e.com/calle/webhook \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'CALL-E-Event-Id: <string>' \
  --header 'CALL-E-Timestamp: <string>' \
  --header 'CALL-E-Signature: <string>' \
  --data '{
  "id": "evt_123",
  "type": "call.completed",
  "created_at": "2026-06-01T17:01:00Z",
  "data": {
    "object": "call_task",
    "id": "call_123",
    "status": "completed",
    "task": "Call each recipient and ask whether they can attend Friday lunch in San Francisco.",
    "recipients": [
      {
        "id": "rcp_123",
        "phones": [
          "<RECIPIENT_1_E164_PHONE>"
        ],
        "locale": "en-US",
        "region": "US",
        "status": "completed",
        "structured_result": {
          "can_attend": "yes"
        },
        "summary": "The recipient can attend Friday lunch.",
        "attempts": [
          {
            "id": "att_123",
            "phone": "<RECIPIENT_1_E164_PHONE>",
            "status": "completed",
            "started_at": "2026-06-01T17:00:05Z",
            "completed_at": "2026-06-01T17:01:00Z",
            "summary": "The recipient can attend Friday lunch.",
            "transcript_turns": [
              {
                "offset_seconds": 0,
                "speaker": "bot",
                "text": "Can you attend Friday lunch in San Francisco?"
              },
              {
                "offset_seconds": 8,
                "speaker": "user",
                "text": "Yes, I can attend."
              }
            ],
            "provider_call_id": "provider_call_123",
            "failure_code": null,
            "failure_message": null
          }
        ]
      }
    ],
    "structured_result": {
      "completed_count": 1
    },
    "summary": "The recipient can attend Friday lunch.",
    "task_completed": true,
    "completion_confidence": {
      "score": 0.92,
      "label": "high"
    },
    "evidence": [
      "The recipient said yes."
    ],
    "metadata": {
      "workflow_run_id": "wf_123"
    },
    "failure_code": null,
    "failure_message": null,
    "created_at": "2026-06-01T17:00:00Z",
    "completed_at": "2026-06-01T17:01:00Z"
  }
}'

Example Request Body

{
  "id": "evt_123",
  "type": "call.completed",
  "created_at": "2026-06-01T17:01:00Z",
  "data": {
    "object": "call_task",
    "id": "call_123",
    "status": "completed",
    "task": "Call each recipient and ask whether they can attend Friday lunch in San Francisco.",
    "recipients": [
      {
        "id": "rcp_123",
        "phones": [
          "<RECIPIENT_1_E164_PHONE>"
        ],
        "locale": "en-US",
        "region": "US",
        "status": "completed",
        "structured_result": {
          "can_attend": "yes"
        },
        "summary": "The recipient can attend Friday lunch.",
        "attempts": [
          {
            "id": "att_123",
            "phone": "<RECIPIENT_1_E164_PHONE>",
            "status": "completed",
            "started_at": "2026-06-01T17:00:05Z",
            "completed_at": "2026-06-01T17:01:00Z",
            "summary": "The recipient can attend Friday lunch.",
            "transcript_turns": [
              {
                "offset_seconds": 0,
                "speaker": "bot",
                "text": "Can you attend Friday lunch in San Francisco?"
              },
              {
                "offset_seconds": 8,
                "speaker": "user",
                "text": "Yes, I can attend."
              }
            ],
            "provider_call_id": "provider_call_123",
            "failure_code": null,
            "failure_message": null
          }
        ]
      }
    ],
    "structured_result": {
      "completed_count": 1
    },
    "summary": "The recipient can attend Friday lunch.",
    "task_completed": true,
    "completion_confidence": {
      "score": 0.92,
      "label": "high"
    },
    "evidence": [
      "The recipient said yes."
    ],
    "metadata": {
      "workflow_run_id": "wf_123"
    },
    "failure_code": null,
    "failure_message": null,
    "created_at": "2026-06-01T17:00:00Z",
    "completed_at": "2026-06-01T17:01:00Z"
  }
}

json

application/json

Example Responses

{
  "ok": true
}

json

application/json

calls

Server Message

POST

https://api.heycall-e.com

/calle/webhook

CALL-E sends this request to your server when a call reaches a terminal state. Configure this URL with webhook_url on create call or through project-level webhook settings.

Server Message › Headers

CALL-E-Event-Id

string · pattern: ^evt_[A-Za-z0-9_-]+$ · required

Unique webhook event id. Store this value before side effects so duplicate deliveries can be ignored safely.

CALL-E-Timestamp

string · required

Unix timestamp used in the signed payload. Verify this header together with CALL-E-Signature before parsing JSON.

CALL-E-Signature

string · required

HMAC SHA-256 signature in the form v1=<hex digest>, computed over timestamp + "." + raw_body with your webhook secret.

Server Message › Request Body

Event payload CALL-E sends to your webhook receiver.

WebhookEvent

id

string · required

Unique webhook event id. Use it as an idempotency key when processing webhook side effects.

type

WebhookEventType · enum · required

Terminal event type for the call.

Enum values:

call.completed

call.failed

call.result_validation_failed

created_at

string · date-time · required

ISO 8601 timestamp when CALL-E created this webhook event.

WebhookCallData · required

Terminal call task snapshot associated with the webhook event.

Server Message › Responses

Webhook accepted.

Example acknowledgement response from your webhook receiver. CALL-E treats any 2xx response as delivered and ignores the response body.

WebhookAcknowledgement

ok

boolean

Optional acknowledgement flag returned by your server.