Vapi · Schema

MessageAddHookAction

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
type string This is the type of action - must be "message.add"
message object The message to add to the conversation in OpenAI format
triggerResponseEnabled boolean Whether to trigger an assistant response after adding the message
View JSON Schema on GitHub

JSON Schema

vapi-messageaddhookaction-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MessageAddHookAction",
  "title": "MessageAddHookAction",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "This is the type of action - must be \"message.add\"",
      "enum": [
        "message.add"
      ]
    },
    "message": {
      "description": "The message to add to the conversation in OpenAI format",
      "example": {
        "role": "system",
        "content": "Context update from hook"
      },
      "allOf": [
        {
          "$ref": "#/components/schemas/OpenAIMessage"
        }
      ]
    },
    "triggerResponseEnabled": {
      "type": "boolean",
      "description": "Whether to trigger an assistant response after adding the message",
      "default": true
    }
  },
  "required": [
    "type",
    "message"
  ]
}