Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-in.getello.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Getting Started

Ello.AI supports six webhook event types across two categories: Call Events and Campaign Events.

​
Event Types Overview

Event TypeTriggerContains
call.startedA call is ConnectedAgent name, agent ID, conversation details
call.completedCall attempt finishesduration, status, call metrics
call.processedAll post-call processing completesRecordings, transcripts, credits, Call insights
call.recordingRecording upload completesRecording URL and metadata
campaign.startedCampaign becomes activeCampaign details, contact count, timestamps
campaign.endedCampaign finishesCall statistics, credits consumed, durations

​
Configuration & Setup

To subscribe your agent to webhook events, use a PUT request to update event subscriptions: 
curl --location --request PUT 'https://api.getello.ai/api/agents/{agent_id}/webhook' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer your_token_here' \
  --header 'X-API-KEY: your-api-key-here' \
  --data '{
    "webhooks": [
      {
        "events": ["call.started", "call.completed", "call.processed"],
        "url": "https://your-domain.com/webhooks",
        "headers": {
          "Authorization": "Bearer your-webhook-token",
          "Content-Type": "application/json"
        },
        "method": "POST"
      }
    ]
  }'

​
Parameters

ParameterTypeRequiredDescription
methodstringYesHTTP method (POST, GET, PUT, PATCH) - defaults to POST
headersobjectNoCustom headers for secure webhook delivery
webhooksarrayYesArray of webhook subscription configurations
eventsarrayYesList of event types to subscribe to
urlstringYesHTTPS URL where webhooks will be sent

​
Subscription Examples

​
Subscribe to Only Call Events

{
  "webhooks": [
    {
      "events": ["call.started", "call.completed", "call.processed"],
      "url": "https://your-domain.com/webhooks/calls",
      "headers": {
        "Authorization": "Bearer your-webhook-token"
      },
	  "method": "POST"
    }
  ]
}

​
Subscribe to Campaign Events Only

{
  "webhooks": [
    {
      "events": ["campaign.started", "campaign.ended"],
      "url": "https://your-domain.com/webhooks/campaigns",
      "headers": {
        "Authorization": "Bearer your-webhook-token"
      },
	  "method": "POST"
    }
  ]
}

​
Multiple Webhook Endpoints

{
  "webhooks": [
    {
      "events": ["call.started", "call.completed"],
      "url": "https://your-domain.com/webhooks/calls",
      "headers": {
        "Authorization": "Bearer webhook-token-1"
      },
	  "method": "POST"
    },
    {
      "events": ["campaign.started", "campaign.ended"],
      "url": "https://another-domain.com/webhooks",
      "headers": {
        "Authorization": "Bearer webhook-token-2"
      },
	  "method": "POST"
    }
  ]
}