An event that occurs during a voice call, such as call started, ended, tool executed, or state changes.

CallEvent

An event that occurs during a voice call, such as call started, ended, tool executed, or state changes.

Properties

id (string): Unique identifier for the event.
type (string): Event type (started, ended, tool-called, transferred, recording-started, etc.).
call ([[Call]]): The call this event belongs to.
assistant ([[VapiAssistant]]): The assistant handling the call.
phoneNumber ([[VapiPhoneNumber]]): Phone number involved in the call.
timestamp (number): When the event occurred (Unix timestamp).
status (string): Event status (success, failed, pending).
message (string): Human-readable event description.
severity (string): Event severity (info, warning, error, critical).
category (string): Event category (lifecycle, tool, quality, error, system).
actor (string): Who triggered the event (assistant, user, system).
previousState (string): Call state before event.
newState (string): Call state after event.
duration (number): Duration of event in milliseconds.
data (object): Event-specific data payload.
tool ([[VapiTool]]): Tool involved in event (for tool events).
toolParameters (object): Parameters passed to tool.
toolResult (object): Tool execution result.
error (object): Error details if event represents an error.
errorCode (string): Error code.
errorMessage (string): Error message.
stackTrace (string): Stack trace for errors.
transcript (string): Transcript snippet related to event.
sentiment (string): Sentiment at time of event (positive, neutral, negative).
metadata (object): Additional event metadata.
webhookDelivered (boolean): Whether event was delivered via webhook.
webhookUrl ([[URL]]): Webhook URL that received event.
webhookStatus (number): HTTP status of webhook delivery.
webhookAttempts (number): Number of webhook delivery attempts.
webhookLastAttempt (number): Timestamp of last webhook attempt (Unix timestamp).
retryable (boolean): Whether event can be retried.
retryCount (number): Number of retry attempts.
sequence (number): Event sequence number in call.
sessionId (string): Session identifier.
correlationId (string): Correlation ID for tracking related events.
tags (string[]): Tags for categorization.
created (number): Timestamp when event was created (Unix timestamp).