Dixa
65 actions · 33 events · 1 auth method
Preview
Authentication
API Key
The steps in this guide require Admin privileges within Dixa.Guides: Connector Profile, Link Account
Actions
65 actions
Action
Description
List Agents
List all agents and admins in the organization
Get Agent
Get an agent or admin by ID
Create Agent
Create a new agent
Patch Agent
Partially update an agent or admin
Delete Agent
Delete an agent or admin
Get Agent Presence
Get the presence status for an agent or admin
List Agents Presence
List presence status for all agents
List Agent Teams
List teams that an agent belongs to
List Contact Endpoints
List all contact endpoints in the organization
Get Contact Endpoint
Get a contact endpoint by ID
Get Conversation
Get a conversation by ID
Create Conversation
Create a new conversation
Close Conversation
Mark a conversation as closed
Reopen Conversation
Reopen a closed conversation
Followup Conversation
Follow up a conversation with expiration timestamp
Transfer Conversation To Queue
Transfer a conversation to a different queue for rerouting. Use search_conversations to find the conversation ID and lis…
Claim Conversation
Assign an open conversation to a specific agent. Use search_conversations to find the conversation ID and list_agents to…
Anonymize Conversation
Request the anonymization of a conversation
List Conversation Messages
Get all messages for a conversation
Add Conversation Message
Add a message to a conversation
List Conversation Internal Notes
Get all internal notes for a conversation
Add Conversation Internal Note
Add an internal note to a conversation
List Conversation Tags
Get all tags for a conversation
Tag Conversation
Add a tag to a conversation
Untag Conversation
Remove a tag from a conversation
List Conversation Ratings
List ratings for a conversation
Create Rating Offer
Create a rating offer for a conversation
Submit Rating Result
Submit a rating result for a conversation
List Conversation Flows
List all conversation flows in an organization
Search Conversations
Search for conversations with filters
Patch Conversation Custom Attributes
Update custom attribute values on a conversation. Map each attribute UUID (from list_custom_attributes) to its new value…
List Custom Attributes
List all custom attribute definitions
Get Custom Attribute
Get details of a custom attribute by UUID. Use list_custom_attributes first to get available UUIDs, then call this for f…
List End Users
List all end users in the organization
Get End User
Get an end user by ID
Create End User
Create a new end user
Patch End User
Partially update an end user
Anonymize End User
Request the anonymization of an end user
Patch End User Custom Attributes
Update custom attribute values on an end user. Map each attribute UUID (from list_custom_attributes) to its new value.
List End User Conversations
List conversations requested by an end user
List Knowledge Collections
List all knowledge base collections
Get Knowledge Article
Get a knowledge base article by ID
Get Organization
Get organization details associated with the API token
List Queues
List all queues in the organization
Get Queue
Get a queue by ID
Create Queue
Create a new queue
List Queue Members
List all agents/admins that are members of a queue
Assign Agents To Queue
Assign agents/admins to a queue
List Tags
List all tags in the organization
Get Tag
Get a tag by ID
Create Tag
Create a new tag
Delete Tag
Delete a tag permanently
List Teams
List all teams in the organization
Get Team
Get a team by ID
Create Team
Create a new team
Delete Team
Delete a team
List Team Members
List all members of a team
Add Team Members
Add members to a team
Remove Team Members
Remove members from a team
List Templates
List all templates in the organization
List Webhooks
List all webhook subscriptions
Get Webhook
Get a webhook subscription by ID
Create Webhook
Create a new webhook subscription
Patch Webhook
Patch a webhook subscription
Delete Webhook
Delete a webhook subscription
Events
33 events
Event
Description
Conversation Created Webhook
Processes Dixa CONVERSATION_CREATED events.
Conversation Open Webhook
Processes Dixa CONVERSATION_OPEN events.
Conversation Pending Webhook
Processes Dixa CONVERSATION_PENDING events.
Conversation Pending Expired Webhook
Processes Dixa CONVERSATION_PENDING_EXPIRED events.
Conversation Closed Webhook
Processes Dixa CONVERSATION_CLOSED events.
Conversation Abandoned Webhook
Processes Dixa CONVERSATION_ABANDONED events.
Conversation Enqueued Webhook
Processes Dixa CONVERSATION_ENQUEUED events.
Conversation Assigned Webhook
Processes Dixa CONVERSATION_ASSIGNED events.
Conversation Unassigned Webhook
Processes Dixa CONVERSATION_UNASSIGNED events.
Conversation Note Added Webhook
Processes Dixa CONVERSATION_NOTE_ADDED events.
Conversation Message Added Webhook
Processes Dixa CONVERSATION_MESSAGE_ADDED events.
Conversation Tag Added Webhook
Processes Dixa CONVERSATION_TAG_ADDED events.
Conversation Tag Removed Webhook
Processes Dixa CONVERSATION_TAG_REMOVED events.
Conversation Rated Webhook
Processes Dixa CONVERSATION_RATED events.
Conversation Transferred Webhook
Processes Dixa CONVERSATION_TRANSFERRED events.
Conversation End User Replaced Webhook
Processes Dixa CONVERSATION_END_USER_REPLACED events.
Conversation Custom Attribute Updated Webhook
Processes Dixa CONVERSATION_CUSTOM_ATTRIBUTE_UPDATED events.
Conversation Message Delivery Delivered Webhook
Processes Dixa CONVERSATION_MESSAGE_DELIVERY_DELIVERED events.
Conversation Message Delivery Info Webhook
Processes Dixa CONVERSATION_MESSAGE_DELIVERY_INFO events.
Conversation Message Delivery Failed Webhook
Processes Dixa CONVERSATION_MESSAGE_DELIVERY_FAILED events.
Conversation Message Delivery Seen Webhook
Processes Dixa CONVERSATION_MESSAGE_DELIVERY_SEEN events.
Conversation Message Delivery Sent Webhook
Processes Dixa CONVERSATION_MESSAGE_DELIVERY_SENT events.
Conversation Message Delivery Spam Complaint Webhook
Processes Dixa CONVERSATION_MESSAGE_DELIVERY_SPAM_COMPLAINT events.
Agent Banned Enduser Webhook
Processes Dixa AGENT_BANNED_ENDUSER events.
Agent Unbanned Enduser Webhook
Processes Dixa AGENT_UNBANNED_ENDUSER events.
Agent Banned IP Webhook
Processes Dixa AGENT_BANNED_IP events.
Agent Unbanned IP Webhook
Processes Dixa AGENT_UNBANNED_IP events.
Typing Started Webhook
Processes Dixa TYPING_STARTED events.
SLA Evaluation Pending Webhook
Processes Dixa SLA_EVALUATION_PENDING events.
SLA Evaluation Breached Webhook
Processes Dixa SLA_EVALUATION_BREACHED events.
SLA Evaluation Achieved Webhook
Processes Dixa SLA_EVALUATION_ACHIEVED events.
SLA Evaluation Voided Webhook
Processes Dixa SLA_EVALUATION_VOIDED events.
Dixa Event Webhook
Generic fallback handler that emits any Dixa event using its event_fqn as the event type.
Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See the Projects Guide.
2
Configure the Connector
Enable the connector and set up a connector profile in your project. See Managing Connectors.
Connector Profile
Dixa - API Key
3
Link an Account
Connect an account using StackOne Hub or Auth Link.
Link Account
Dixa - API Key
4
Use Actions
Invoke actions using one of the methods below:
- MCP – Model Context Protocol for AI assistants
- A2A – Agent-to-Agent protocol
- AI Toolset (TypeScript) – TypeScript SDK for AI agents
- AI Toolset (Python) – Python SDK for AI agents
- Actions RPC – Direct API calls
- Playground – Test actions in the dashboard
Webhook Events
Webhooks setup
Configure receiving Events for Dixa into StackOne.