Skip to Content
CallMitraDocs

Event types

Every webhook event CallMitra sends, when it fires, the fields in its data, and a sample body.

Every delivery to a webhook endpoint has the same envelope. The event's own fields are in data.

{
  "id": "evt_5f0c6a1e9b2d4c7e8a1f3b5d7c9e0a2b",
  "type": "call.completed",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T05:31:50.412093Z",
  "data": {}
}

The type field and the X-Webhook-Event header tell events apart. New event types and new fields in data can be added at any time (see Versioning). Ignore fields and event types you do not use. Event names are never renamed or removed.

Each event links to its page in the API reference, which has the full schema. You can also list the types with GET /api/v1/webhook-event-types/.

Catalogue

EventWhen it firesAlso sent to campaign and agent URLs
call.completedA call ended, with any final status. Sent after post-call analysis.Yes
call.failedA call ended without connecting: busy, no answer or carrier failure. Sent together with call.completed.No
call.escalatedThe agent transferred the caller to a person.Yes
transfer.failedA transfer to a person did not connect.If enabled
callback.scheduledA callback was booked for a lead.If enabled
callback.completedA booked callback was made.If enabled
callback.failedA booked callback could not reach the lead after its attempts.If enabled
lead.createdA lead was added one at a time: through the API, the console's add-lead form or a lead source. Not sent for bulk imports.No
lead.updatedA lead was edited in the console or through the API.No
campaign.startedA campaign was started.No
campaign.completedA campaign finished dialing every lead.No
ticket.createdA support ticket was opened.No
ticket.updatedA support ticket changed.No
ticket.resolvedA support ticket was resolved.No
ticket.reopenedA resolved or closed ticket opened again.No
ticket.ratedA customer rated a support ticket.No
whatsapp.message.receivedA customer sent a WhatsApp message to one of your numbers.No
webhook.testYou sent a test event. Cannot be subscribed to.No

call.completed and call.failed

call.completed is sent once per call when it ends, answered or not. CallMitra waits about 20 seconds after the call ends so the post-call analysis is ready, and reads the call's data when the first attempt is sent.

call.failed is sent for the same call, at the same time, only when the final status is failed, busy or no_answer. Its data is the same as call.completed. The two events have different ids. Subscribe to call.failed alone if you only want to act on calls that did not connect.

Reference: call.completed, call.failed.

FieldTypeDescription
callIdUUIDThe call. Fetch details with GET /api/v1/calls/{call_id}.
campaignIdUUID or nullThe campaign that placed or received the call.
leadIdUUID or nullThe lead called.
agentIdUUID or nullThe agent that handled the call.
phonestring or nullThe lead's phone number, or the dialed number when there is no lead.
customerNumberstring or nullThe number dialed, or the caller's number.
leadobject or nullid, name, phone, email, company, externalId, and customFields (your custom fields, minus sensitive and archived ones).
directionstringoutbound or inbound.
statusstringFinal call status, for example completed, no_answer, busy or failed.
durationnumber or nullTalk time in seconds.
endedReasonstring or nullWhy the call ended.
startTime, endTimestring or nullISO 8601, UTC.
recordingUrlstring or nullRecording URL. Fetch it with your X-API-Key; see GET /api/v1/calls/{call_id}/recording.
summarystring or nullAI summary of the conversation.
transcriptstring or nullFull transcript.
outcome, outcomeCategorystring or nullThe agent's detailed outcome and its category.
merchantOutcomestringNormalized outcome: qualified, interested, callback, not_interested, no_response, no_answer, busy, call_failed, voicemail, or empty.
sentimentstring or nullpositive, neutral or negative, when analyzed.
extractedFieldsobjectValues the agent collected, keyed by the field names set on the agent.
callAnalysisobject or nullThe full post-call analysis.
recommendedLeadStatusstring or nullSuggested next status for the lead in your CRM.
crmPayloadobject or nullEverything the call stored for your CRM, including the analysis and transfer details.
providerCallIdstring or nullThe carrier's call id.
call.completed
{
  "id": "evt_5f0c6a1e9b2d4c7e8a1f3b5d7c9e0a2b",
  "type": "call.completed",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T05:31:50.412093Z",
  "data": {
    "callId": "3f2b8c1e-6a4d-4f7e-9b1a-2c5d8e9f0a1b",
    "campaignId": "8a7d9c2b-1e3f-4a5b-8c6d-7e8f9a0b1c2d",
    "leadId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "phone": "+919876543210",
    "customerNumber": "+919876543210",
    "agentId": "5c4b3a29-1807-4f6e-9d8c-7b6a59483726",
    "lead": {
      "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "name": "Asha Rao",
      "phone": "+919876543210",
      "email": "",
      "company": "",
      "externalId": "crm-1042",
      "customFields": { "plan": "Gold" }
    },
    "direction": "outbound",
    "status": "completed",
    "duration": 94,
    "endedReason": "customer-ended-call",
    "startTime": "2026-11-15T05:30:12+00:00",
    "endTime": "2026-11-15T05:31:46+00:00",
    "recordingUrl": "https://api.callmitra.ai/api/v1/calls/3f2b8c1e-6a4d-4f7e-9b1a-2c5d8e9f0a1b/recording",
    "summary": "Customer wants to renew the Gold plan and asked for a callback on Monday.",
    "transcript": "Agent: Namaste Asha ji…",
    "outcome": "callback_requested",
    "outcomeCategory": "positive",
    "merchantOutcome": "callback",
    "sentiment": "positive",
    "extractedFields": { "preferredCallbackDay": "Monday" },
    "callAnalysis": { "summary": "…" },
    "recommendedLeadStatus": "follow_up",
    "crmPayload": { "callAnalysis": { "summary": "…" } },
    "providerCallId": "CA1234567890abcdef"
  }
}

call.escalated

Sent when the agent transfers a call to a person, for example a warm transfer to your sales team. The same call still sends call.completed when it ends. If the transfer does not connect, transfer.failed is sent too.

Reference: call.escalated.

FieldTypeDescription
callId, campaignId, leadId, agentIdUUID or nullAs for call.completed.
phone, customerNumber, lead, directionAs for call.completed.
transferTypestring or nullHow the call was handed over, for example cold_pstn, cold_sip or warm_mpc.
transferTargetstring or nullWhere it was transferred to.
transferStatusstring or nullState of the transfer, for example initiated.
transferDialStatusstring or nullThe carrier's answer for the transfer leg, when known.
transferReasonstring or nullWhy the agent escalated.
endedReasonstring or nullWhy the call ended.
providerCallIdstring or nullThe carrier's call id.
call.escalated
{
  "id": "evt_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
  "type": "call.escalated",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T05:31:02.118540Z",
  "data": {
    "callId": "3f2b8c1e-6a4d-4f7e-9b1a-2c5d8e9f0a1b",
    "campaignId": "8a7d9c2b-1e3f-4a5b-8c6d-7e8f9a0b1c2d",
    "leadId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "phone": "+919876543210",
    "customerNumber": "+919876543210",
    "agentId": "5c4b3a29-1807-4f6e-9d8c-7b6a59483726",
    "lead": { "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed", "name": "Asha Rao", "phone": "+919876543210" },
    "direction": "outbound",
    "transferType": "cold_pstn",
    "transferTarget": "+918041234567",
    "transferStatus": "initiated",
    "transferDialStatus": null,
    "transferReason": "Customer asked to speak to a sales manager.",
    "endedReason": "transfer_initiated",
    "providerCallId": "CA1234567890abcdef"
  }
}

transfer.failed

Sent when a transfer to a person does not connect.

Reference: transfer.failed.

FieldTypeDescription
callIdUUIDThe call.
leadId, campaignId, agentIdUUID or nullThe lead, campaign and agent of the call.
dialStatusstring or nullThe carrier's answer, for example no-answer or busy.
transfer.failed
{
  "id": "evt_1d2c3b4a5f6e7d8c9b0a1f2e3d4c5b6a",
  "type": "transfer.failed",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T05:31:20.007311Z",
  "data": {
    "callId": "3f2b8c1e-6a4d-4f7e-9b1a-2c5d8e9f0a1b",
    "leadId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "campaignId": "8a7d9c2b-1e3f-4a5b-8c6d-7e8f9a0b1c2d",
    "agentId": "5c4b3a29-1807-4f6e-9d8c-7b6a59483726",
    "dialStatus": "no-answer"
  }
}

Callback events

callback.scheduled fires when a callback is booked for a lead, for example when the caller asks the agent to call back later. callback.completed fires when the callback call is made. callback.failed fires when the callback could not reach the lead after its attempts. All three have the same data.

Reference: callback.scheduled, callback.completed, callback.failed.

FieldTypeDescription
callbackIdUUIDThe callback.
leadIdUUIDThe lead to call back.
kindstringcallback or reminder.
campaignId, agentIdUUID or nullThe campaign and agent that make the call.
whenstringThe callback time in the lead's time zone, readable, for example Tue 4 Nov, 5:00 PM.
dialAtstringThe callback time, ISO 8601.
attemptsintegerAttempts made so far.
sourcestringHow it was booked: ai_tool (the agent during a call), analysis, keyword, console, api, csv, rule or handoff.
notestringThe note saved with the callback.
callback.scheduled
{
  "id": "evt_4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e",
  "type": "callback.scheduled",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T05:31:40.551902Z",
  "data": {
    "callbackId": "c2d4e6f8-1a3b-4c5d-8e7f-9a0b1c2d3e4f",
    "leadId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "kind": "callback",
    "campaignId": "8a7d9c2b-1e3f-4a5b-8c6d-7e8f9a0b1c2d",
    "agentId": "5c4b3a29-1807-4f6e-9d8c-7b6a59483726",
    "when": "Mon 17 Nov, 11:00 AM",
    "dialAt": "2026-11-17T05:30:00+00:00",
    "attempts": 0,
    "source": "ai_tool",
    "note": "Wants to discuss Gold plan renewal."
  }
}

lead.created and lead.updated

lead.created fires for leads added one at a time:

  • createLead;
  • the console's add-lead form;
  • each lead a connected lead source delivers (Meta lead ads, Google Ads lead forms, lead-source webhooks).

It is not sent for:

  • spreadsheet imports, campaign lead uploads, or campaigns created with leads;
  • leads made automatically for WhatsApp contacts, unknown inbound callers, outbound calls to a new number, or do-not-call entries.

After a bulk import, list the leads with GET /api/v1/leads/ instead of waiting for events.

lead.updated fires when a lead is edited in the console or through the API. Both carry the lead as it is after the change.

Reference: lead.created, lead.updated. To fetch a lead later, use GET /api/v1/leads/{lead_id}.

FieldTypeDescription
idUUIDThe lead.
name, phone, email, companystringContact details.
externalIdstring or nullYour id for this lead, when you sent one.
customFieldsobjectCustom field values, minus sensitive and archived fields.
titlestringThe lead's title.
statusstring or nullPipeline status, for example new.
sourcestringWhere the lead came from, as set on the lead.
leadSourceIdUUID or nullThe lead source that created it, if any.
tagsstring[]Tags.
assignedToUserIdUUID or nullThe user the lead is assigned to.
callStatusstring or nullCalling state, for example not_called.
createdAt, updatedAtstring or nullISO 8601.
lead.created
{
  "id": "evt_7e6d5c4b3a2f1e0d9c8b7a6f5e4d3c2b",
  "type": "lead.created",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T04:12:08.300114Z",
  "data": {
    "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "name": "Asha Rao",
    "phone": "+919876543210",
    "email": "[email protected]",
    "company": "",
    "externalId": "crm-1042",
    "customFields": { "plan": "Gold" },
    "title": "",
    "status": "new",
    "source": "website",
    "leadSourceId": null,
    "tags": ["renewal"],
    "assignedToUserId": null,
    "callStatus": "not_called",
    "createdAt": "2026-11-15T04:12:08.291004+00:00",
    "updatedAt": "2026-11-15T04:12:08.291004+00:00"
  }
}

campaign.started and campaign.completed

campaign.started fires when a campaign is started. For an inbound campaign, that is when it is turned on. campaign.completed fires when an outbound campaign has dialed every lead.

Reference: campaign.started, campaign.completed.

FieldTypeDescription
campaignIdUUIDThe campaign.
namestringCampaign name.
directionstringoutbound or inbound.
agentIdUUID or nullThe campaign's agent.
startedAtstring or nullWhen dialing started, ISO 8601.
completedAtstringWhen it finished, ISO 8601. Only on campaign.completed.
campaign.completed
{
  "id": "evt_0f1e2d3c4b5a69788796a5b4c3d2e1f0",
  "type": "campaign.completed",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T09:45:00.120044Z",
  "data": {
    "campaignId": "8a7d9c2b-1e3f-4a5b-8c6d-7e8f9a0b1c2d",
    "name": "Gold renewals – November",
    "direction": "outbound",
    "agentId": "5c4b3a29-1807-4f6e-9d8c-7b6a59483726",
    "startedAt": "2026-11-15T04:30:00.004512+00:00",
    "completedAt": "2026-11-15T09:45:00.118201+00:00"
  }
}

Ticket events

EventWhen it fires
ticket.createdA ticket is opened.
ticket.updatedA ticket changes: an edit, an assignment, a merge, an SLA breach, or a status change to anything other than resolved.
ticket.resolvedThe status changes to resolved.
ticket.reopenedA resolved or closed ticket opens again.
ticket.ratedThe customer rates the ticket.

A reopen sends two events

When a ticket reopens, CallMitra sends ticket.updated (for the status change) and ticket.reopened. If you subscribe to both, handle the reopen in one place. Closing a ticket (status closed) sends ticket.updated.

Reference: ticket.created, ticket.updated, ticket.resolved, ticket.reopened, ticket.rated.

FieldTypeDescription
ticketIdUUIDThe ticket.
ticketRefstringShort reference shown to the customer, for example T-D4C3B2A1.
merchantIdUUID or nullYour workspace id.
leadIdUUIDThe customer's lead.
typestringsupport or sales_followup.
statusstringopen, in_progress, waiting_on_customer, resolved or closed.
prioritystringlow, normal, high or urgent.
subjectstringSubject line.
descriptionstring or nullDetails.
sourcestringWhere the ticket came from: manual, inbound_call, outbound_call, import or whatsapp_conversation.
sourceCallIdUUID or nullThe call that created it, if any.
assignedToUserIdUUID or nullThe main assignee.
assigneesobject[]Every assignee: userId, name, email.
dueAt, firstResponseAt, resolvedAt, closedAtstring or nullISO 8601 times.
csatScoreinteger or nullThe customer's rating. Set on ticket.rated.
csatAtstring or nullWhen the customer rated it.
versionintegerGoes up by one with each change. Use it to ignore older events that arrive late.
category, teamobjectid and name. Only when the ticket has one.
tagsstring[]Only when the ticket has tags.
mergedIntoobjectid and ref of the ticket it was merged into. Only after a merge.
previousStatusstringThe status before the reopen. Only on ticket.reopened.
reopenedBystringWhat reopened it, for example customer. Only on ticket.reopened.

Some changes add extra keys that describe the change. Ignore keys you do not know.

ticket.resolved
{
  "id": "evt_6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d",
  "type": "ticket.resolved",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T11:02:33.741220Z",
  "data": {
    "ticketId": "d4c3b2a1-9f8e-4d7c-b6a5-0f1e2d3c4b5a",
    "ticketRef": "T-D4C3B2A1",
    "merchantId": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
    "leadId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "type": "support",
    "status": "resolved",
    "priority": "high",
    "subject": "Renewal payment failed",
    "description": "Card was charged twice.",
    "source": "inbound_call",
    "sourceCallId": "3f2b8c1e-6a4d-4f7e-9b1a-2c5d8e9f0a1b",
    "assignedToUserId": "9e8d7c6b-5a4f-4e3d-a2c1-b0a9f8e7d6c5",
    "assignees": [
      { "userId": "9e8d7c6b-5a4f-4e3d-a2c1-b0a9f8e7d6c5", "name": "Ravi Kumar", "email": "[email protected]" }
    ],
    "dueAt": "2026-11-16T05:30:00+00:00",
    "firstResponseAt": "2026-11-15T06:10:00+00:00",
    "resolvedAt": "2026-11-15T11:02:33.720018+00:00",
    "closedAt": null,
    "csatScore": null,
    "csatAt": null,
    "version": 4,
    "category": { "id": "0c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f", "name": "Billing" },
    "tags": ["refund"]
  }
}

whatsapp.message.received

Sent when a customer sends a message to one of your WhatsApp numbers. Each message is sent once, even if WhatsApp reports it twice.

Reference: whatsapp.message.received.

FieldTypeDescription
conversationIdUUIDThe conversation.
phoneIdUUIDYour WhatsApp number that received the message.
windowOpenbooleantrue while you can send free-form replies.
serviceWindowExpiresAtstring or nullWhen the reply window closes, ISO 8601.
contactobjectid, name, phone, bsuid, username, leadId, optInStatus, tags.
entrySourcestring or nullHow the conversation started, when known.
message.idUUIDCallMitra's message id.
message.wamidstring or nullWhatsApp's message id.
message.typestringtext, image, button, interactive, location and so on.
message.textstring or nullThe text, caption or button label.
message.payloadobjectExtra content for some types, for example location or button_payload. Empty for plain text. Its keys are not converted to camelCase.
message.hasMediabooleantrue when the message has a file.
message.mediaMime, message.mediaFilenamestring or nullFile type and name.
message.replyToWamidstring or nullThe message this one replies to.
message.createdAtstring or nullISO 8601.
whatsapp.message.received
{
  "id": "evt_3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a8f",
  "type": "whatsapp.message.received",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T07:20:14.009871Z",
  "data": {
    "conversationId": "5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9",
    "phoneId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "windowOpen": true,
    "serviceWindowExpiresAt": "2026-11-16T07:20:13+00:00",
    "contact": {
      "id": "f0e1d2c3-b4a5-4968-8776-655443322110",
      "name": "Asha Rao",
      "phone": "+919876543210",
      "bsuid": null,
      "username": null,
      "leadId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "optInStatus": "opted_in",
      "tags": []
    },
    "entrySource": null,
    "message": {
      "id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e",
      "wamid": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhgg",
      "type": "text",
      "text": "Is my renewal done?",
      "payload": {},
      "hasMedia": false,
      "mediaMime": null,
      "mediaFilename": null,
      "replyToWamid": null,
      "createdAt": "2026-11-15T07:20:13.882140+00:00"
    }
  }
}

webhook.test

Sent only when you call POST /api/v1/webhook-endpoints/{endpoint_id}/test. It goes to that one endpoint, whatever its event filter. You cannot subscribe to it.

Reference: webhook.test.

webhook.test
{
  "id": "evt_2c4e6a8b0d1f3a5c7e9b1d3f5a7c9e1b",
  "type": "webhook.test",
  "apiVersion": "v1",
  "createdAt": "2026-11-15T05:35:11.810422Z",
  "data": {
    "endpointId": "7c1e2f4a-9b3d-4e8f-a6c2-1d5b7e9f0a3c",
    "message": "This is a test event from Call Mitra."
  }
}

On this page