Vapi · Schema

CallHookCallEnding

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
on string This is the event that triggers this hook
do array This is the set of actions to perform when the hook triggers
filters array This is the set of filters that must match for the hook to trigger
View JSON Schema on GitHub

JSON Schema

vapi-callhookcallending-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallHookCallEnding",
  "title": "CallHookCallEnding",
  "type": "object",
  "properties": {
    "on": {
      "type": "string",
      "description": "This is the event that triggers this hook",
      "enum": [
        "call.ending"
      ],
      "maxLength": 1000
    },
    "do": {
      "type": "array",
      "description": "This is the set of actions to perform when the hook triggers",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/ToolCallHookAction",
            "title": "ToolCallHookAction"
          },
          {
            "$ref": "#/components/schemas/MessageAddHookAction",
            "title": "MessageAddHookAction"
          }
        ]
      }
    },
    "filters": {
      "description": "This is the set of filters that must match for the hook to trigger",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CallHookFilter"
      }
    }
  },
  "required": [
    "on",
    "do"
  ]
}