Send AI Chat Event

documented

Send chat events to an AI agent.

POST /api/v1/ai_agents/chatAI Agentsno implementation yet0 runs

Input

platformConversationId

Platform Conversation ID

e.g., 13427e90-f76a-47c2-a26d-ea0b4f1836c5

eventType*

Event Type

startSession | message | endSession | metadata

text

Message Text

User message text (optional for some event types)

metaKey

Meta Data Key

e.g., user_id

metaValue

Meta Data Value

e.g., 12345

sanitize

PII Sanitize

true|false

cardIndex

Card Index

Index for chosen card in a carousel

bot_id*

Bot ID

Bot identifier

Calls Zendesk as you (your API key is your account); keychains.dev holds the credentials.