Skip to main content
WEBHOOK
Integration Prompt for AI Agents
Upon an event on the platform, all webhooks that are subscribed to the specific event will receive the results to the URL you registered within the dashboard.

Authorizations

X-API-Key
string
header
required

API key required to authenticate requests.

Body

application/json

Represents a simulation result evaluated event.

id
integer
required

The ID of the simulation result

digital_human_id
integer
required

The ID of the digital human

simulation_run_id
integer
required

The ID of the simulation run that this simulation result belongs to

simulation_id
integer
required

The ID of the simulation that this simulation result belongs to

agent_id
integer
required

The ID of the agent that this simulation result belongs to

type
string
default:simulation_result_evaluated

Type of webhook payload

status
enum<string>
default:COMPLETED

The status of the simulation result

Available options:
INITIALIZING,
QUEUED,
READY,
DISPATCHED,
RUNNING,
CONVERSATION_ENDED,
EVALUATING,
COMPLETED,
NO_CONNECTION,
NO_ANSWER,
CALL_DROPPED,
OUT_OF_FUNDS,
SYSTEM_ERROR,
CUSTOM_ERROR,
CANCELLED
folder_id
string<uuid> | null

The ID of the folder that the agent belongs to

result
Result · object | null
deprecated

Please use the evaluations instead

custom_metrics
Custom Metric · object[] | null
deprecated

Please use the custom metrics in the evaluations instead

evaluations
Evaluation · object[] | null

The evaluations of the simulation result

created_at
string<date-time> | null

The creation time of the simulation result

start_time
string<date-time> | null

The start time of the simulation result

end_time
string<date-time> | null

The end time of the simulation result

duration
integer | null

The duration of the simulation result

latency
number[] | null

The latency of the simulation result

events
Event · object[] | null

The events of the simulation result

tool_calls
ToolCallData · object[] | null

The tool calls of the simulation result

tags
string[] | null

The tags of the simulation result

metadata
Metadata · object | null

The metadata of the simulation result

Response

200

Webhook received successfully