> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Dixa

> How to set up the Dixa connector, plus the actions and events that are available.

![Dixa](https://stackone-logos.com/api/dixa/filled/svg)

v3.0.1[See changelog](https://docs.stackone.com/connectors/dixa/changelog.md)

[66 actions](#actions) · [33 events](#events) · 1 auth method

Customer Support
Ticketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/dixa/guides/connector-profile/api-key.md)
>
> No app registration required. Access is limited to the permission groups selected when the API token is created.

Optionally, configure receiving Events for Dixa into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/dixa/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/dixa/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

66 actions

ActionDescription

List Agents`dixa_list_agents`

List all agents and admins in the organization

Get Agent`dixa_get_agent`

Get an agent or admin by ID

Create Agent`dixa_create_agent`

Create a new agent

Patch Agent`dixa_patch_agent`

Partially update an agent or admin

Update Agent`dixa_update_agent`

Fully replace an agent or admin

Delete Agent`dixa_delete_agent`

Delete an agent or admin

Get Agent Presence`dixa_get_agent_presence`

Get the presence status for an agent or admin

List Agents Presence`dixa_list_agents_presence`

List presence status for all agents

List Agent Teams`dixa_list_agent_teams`

List teams that an agent belongs to

List Contact Endpoints`dixa_list_contact_endpoints`

List all contact endpoints in the organization

Get Contact Endpoint`dixa_get_contact_endpoint`

Get a contact endpoint by ID

Get Conversation`dixa_get_conversation`

Get a conversation by ID

Create Conversation`dixa_create_conversation`

Create a new conversation

Close Conversation`dixa_close_conversation`

Mark a conversation as closed

Reopen Conversation`dixa_reopen_conversation`

Reopen a closed conversation

Followup Conversation`dixa_followup_conversation`

Follow up a conversation with expiration timestamp

Transfer Conversation To Queue`dixa_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`dixa_claim_conversation`

Assign an open conversation to a specific agent. Use search\_conversations to find the conversation ID and list\_agents to...

Anonymize Conversation`dixa_anonymize_conversation`

Request the anonymization of a conversation

List Conversation Messages`dixa_list_conversation_messages`

Get all messages for a conversation

Add Conversation Message`dixa_add_conversation_message`

Add a message to a conversation

List Conversation Internal Notes`dixa_list_conversation_internal_notes`

Get all internal notes for a conversation

Add Conversation Internal Note`dixa_add_conversation_internal_note`

Add an internal note to a conversation

List Conversation Tags`dixa_list_conversation_tags`

Get all tags for a conversation

Tag Conversation`dixa_tag_conversation`

Add a tag to a conversation

Untag Conversation`dixa_untag_conversation`

Remove a tag from a conversation

List Conversation Ratings`dixa_list_conversation_ratings`

List ratings for a conversation

Create Rating Offer`dixa_create_rating_offer`

Create a rating offer for a conversation

Submit Rating Result`dixa_submit_rating_result`

Submit a rating result for a conversation

List Conversation Flows`dixa_list_conversation_flows`

List all conversation flows in an organization

Search Conversations`dixa_search_conversations`

Search for conversations with filters

Patch Conversation Custom Attributes`dixa_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`dixa_list_custom_attributes`

List all custom attribute definitions

Get Custom Attribute`dixa_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`dixa_list_end_users`

List all end users in the organization

Get End User`dixa_get_end_user`

Get an end user by ID

Create End User`dixa_create_end_user`

Create a new end user

Patch End User`dixa_patch_end_user`

Partially update an end user

Anonymize End User`dixa_anonymize_end_user`

Request the anonymization of an end user

Patch End User Custom Attributes`dixa_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`dixa_list_end_user_conversations`

List conversations requested by an end user

List Knowledge Collections`dixa_list_knowledge_collections`

List all knowledge base collections

Get Knowledge Article`dixa_get_knowledge_article`

Get a knowledge base article by ID

Get Organization`dixa_get_organization`

Get organization details associated with the API token

List Queues`dixa_list_queues`

List all queues in the organization

Get Queue`dixa_get_queue`

Get a queue by ID

Create Queue`dixa_create_queue`

Create a new queue

List Queue Members`dixa_list_queue_members`

List all agents/admins that are members of a queue

Assign Agents To Queue`dixa_assign_agents_to_queue`

Assign agents/admins to a queue

List Tags`dixa_list_tags`

List all tags in the organization

Get Tag`dixa_get_tag`

Get a tag by ID

Create Tag`dixa_create_tag`

Create a new tag

Delete Tag`dixa_delete_tag`

Delete a tag permanently

List Teams`dixa_list_teams`

List all teams in the organization

Get Team`dixa_get_team`

Get a team by ID

Create Team`dixa_create_team`

Create a new team

Delete Team`dixa_delete_team`

Delete a team

List Team Members`dixa_list_team_members`

List all members of a team

Add Team Members`dixa_add_team_members`

Add members to a team

Remove Team Members`dixa_remove_team_members`

Remove members from a team

List Templates`dixa_list_templates`

List all templates in the organization

List Webhooks`dixa_list_webhooks`

List all webhook subscriptions

Get Webhook`dixa_get_webhook`

Get a webhook subscription by ID

Create Webhook`dixa_create_webhook`

Create a new webhook subscription

Patch Webhook`dixa_patch_webhook`

Patch a webhook subscription

Delete Webhook`dixa_delete_webhook`

Delete a webhook subscription

## Events

Tags

Select all
|
Clear

Agents

Conversations

SLA Evaluations

Webhooks

No tags found

33 events

EventDescriptionTags

Conversation Created Webhook`dixa_webhook_conversation_created`

Processes Dixa CONVERSATION\_CREATED events.

ConversationsWebhooks

Conversation Open Webhook`dixa_webhook_conversation_open`

Processes Dixa CONVERSATION\_OPEN events.

ConversationsWebhooks

Conversation Pending Webhook`dixa_webhook_conversation_pending`

Processes Dixa CONVERSATION\_PENDING events.

ConversationsWebhooks

Conversation Pending Expired Webhook`dixa_webhook_conversation_pending_expired`

Processes Dixa CONVERSATION\_PENDING\_EXPIRED events.

ConversationsWebhooks

Conversation Closed Webhook`dixa_webhook_conversation_closed`

Processes Dixa CONVERSATION\_CLOSED events.

ConversationsWebhooks

Conversation Abandoned Webhook`dixa_webhook_conversation_abandoned`

Processes Dixa CONVERSATION\_ABANDONED events.

ConversationsWebhooks

Conversation Enqueued Webhook`dixa_webhook_conversation_enqueued`

Processes Dixa CONVERSATION\_ENQUEUED events.

ConversationsWebhooks

Conversation Assigned Webhook`dixa_webhook_conversation_assigned`

Processes Dixa CONVERSATION\_ASSIGNED events.

ConversationsWebhooks

Conversation Unassigned Webhook`dixa_webhook_conversation_unassigned`

Processes Dixa CONVERSATION\_UNASSIGNED events.

ConversationsWebhooks

Conversation Note Added Webhook`dixa_webhook_conversation_note_added`

Processes Dixa CONVERSATION\_NOTE\_ADDED events.

ConversationsWebhooks

Conversation Message Added Webhook`dixa_webhook_conversation_message_added`

Processes Dixa CONVERSATION\_MESSAGE\_ADDED events.

ConversationsWebhooks

Conversation Tag Added Webhook`dixa_webhook_conversation_tag_added`

Processes Dixa CONVERSATION\_TAG\_ADDED events.

ConversationsWebhooks

Conversation Tag Removed Webhook`dixa_webhook_conversation_tag_removed`

Processes Dixa CONVERSATION\_TAG\_REMOVED events.

ConversationsWebhooks

Conversation Rated Webhook`dixa_webhook_conversation_rated`

Processes Dixa CONVERSATION\_RATED events.

ConversationsWebhooks

Conversation Transferred Webhook`dixa_webhook_conversation_transferred`

Processes Dixa CONVERSATION\_TRANSFERRED events.

ConversationsWebhooks

Conversation End User Replaced Webhook`dixa_webhook_conversation_end_user_replaced`

Processes Dixa CONVERSATION\_END\_USER\_REPLACED events.

ConversationsWebhooks

Conversation Custom Attribute Updated Webhook`dixa_webhook_conversation_custom_attribute_updated`

Processes Dixa CONVERSATION\_CUSTOM\_ATTRIBUTE\_UPDATED events.

ConversationsWebhooks

Conversation Message Delivery Delivered Webhook`dixa_webhook_conversation_message_delivery_delivered`

Processes Dixa CONVERSATION\_MESSAGE\_DELIVERY\_DELIVERED events.

ConversationsWebhooks

Conversation Message Delivery Info Webhook`dixa_webhook_conversation_message_delivery_info`

Processes Dixa CONVERSATION\_MESSAGE\_DELIVERY\_INFO events.

ConversationsWebhooks

Conversation Message Delivery Failed Webhook`dixa_webhook_conversation_message_delivery_failed`

Processes Dixa CONVERSATION\_MESSAGE\_DELIVERY\_FAILED events.

ConversationsWebhooks

Conversation Message Delivery Seen Webhook`dixa_webhook_conversation_message_delivery_seen`

Processes Dixa CONVERSATION\_MESSAGE\_DELIVERY\_SEEN events.

ConversationsWebhooks

Conversation Message Delivery Sent Webhook`dixa_webhook_conversation_message_delivery_sent`

Processes Dixa CONVERSATION\_MESSAGE\_DELIVERY\_SENT events.

ConversationsWebhooks

Conversation Message Delivery Spam Complaint Webhook`dixa_webhook_conversation_message_delivery_spam_complaint`

Processes Dixa CONVERSATION\_MESSAGE\_DELIVERY\_SPAM\_COMPLAINT events.

ConversationsWebhooks

Agent Banned Enduser Webhook`dixa_webhook_agent_banned_enduser`

Processes Dixa AGENT\_BANNED\_ENDUSER events.

AgentsWebhooks

Agent Unbanned Enduser Webhook`dixa_webhook_agent_unbanned_enduser`

Processes Dixa AGENT\_UNBANNED\_ENDUSER events.

AgentsWebhooks

Agent Banned IP Webhook`dixa_webhook_agent_banned_ip`

Processes Dixa AGENT\_BANNED\_IP events.

AgentsWebhooks

Agent Unbanned IP Webhook`dixa_webhook_agent_unbanned_ip`

Processes Dixa AGENT\_UNBANNED\_IP events.

AgentsWebhooks

Typing Started Webhook`dixa_webhook_typing_started`

Processes Dixa TYPING\_STARTED events.

ConversationsWebhooks

SLA Evaluation Pending Webhook`dixa_webhook_sla_evaluation_pending`

Processes Dixa SLA\_EVALUATION\_PENDING events.

SLA EvaluationsWebhooks

SLA Evaluation Breached Webhook`dixa_webhook_sla_evaluation_breached`

Processes Dixa SLA\_EVALUATION\_BREACHED events.

SLA EvaluationsWebhooks

SLA Evaluation Achieved Webhook`dixa_webhook_sla_evaluation_achieved`

Processes Dixa SLA\_EVALUATION\_ACHIEVED events.

SLA EvaluationsWebhooks

SLA Evaluation Voided Webhook`dixa_webhook_sla_evaluation_voided`

Processes Dixa SLA\_EVALUATION\_VOIDED events.

SLA EvaluationsWebhooks

Dixa Event Webhook`dixa_webhook_event`

Generic fallback handler that emits any Dixa event using its event\_fqn as the event type.

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.