Skip to main content
POST
/
v2
/
webhooks
/
call-events
Call Events Webhook
curl --request POST \
  --url https://api.voice-agents.miraiminds.co/v2/webhooks/call-events \
  --header 'Content-Type: application/json' \
  --header 'x-private-key: <api-key>' \
  --header 'x-public-key: <api-key>' \
  --data '
{
  "event": {
    "type": "call.initiate",
    "data": {
      "call": {
        "id": "call_123456",
        "status": "initiate",
        "startedAt": "2023-11-07T05:31:56Z",
        "endedAt": "2023-11-07T05:31:56Z",
        "recordingUrl": "<string>",
        "detailUrl": "<string>",
        "durationSeconds": 45
      },
      "analysis": {
        "success": true,
        "summary": "User expressed interest but requested a callback later.",
        "requiredActions": [
          "<string>"
        ],
        "insights": {
          "interested": true,
          "callback_requested": true
        }
      },
      "credits": {
        "used": 1.5,
        "available": 98.5
      },
      "report": {
        "reAttemptCount": 123,
        "rescheduledCount": 123
      }
    },
    "call": {
      "id": "call_123456",
      "status": "initiate",
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "recordingUrl": "<string>",
      "detailUrl": "<string>",
      "durationSeconds": 45
    },
    "analysis": {
      "success": true,
      "summary": "User expressed interest but requested a callback later.",
      "requiredActions": [
        "<string>"
      ],
      "insights": {
        "interested": true,
        "callback_requested": true
      }
    },
    "credits": {
      "used": 1.5,
      "available": 98.5
    },
    "report": {
      "reAttemptCount": 123,
      "rescheduledCount": 123
    }
  }
}
'

Authorizations

x-public-key
string
header
required
x-private-key
string
header
required

Body

application/json
event
object
required
metadata
object

Response

Event received