Integration API migration guide
We are sunsetting the Integrations API, and here you will learn everything you need to migrate to the Dixa API. And don't worry. We have made an easy-to-use mapping between Integrations and Dixa API endpoints and fields.
- First, you should read about how to access the Dixa API. You can read about how to create an API token in this tutorial .
- Secondly, you must identify the systems that are still using the Integration API. You will need this to understand which Integrations API endpoints you are currently using.
- Finally, use the table below to find the Integration API endpoints and the matching Dixa API endpoint in the column to the right.
Conversations
| Name | Integrations API | Dixa API |
|---|---|---|
| Get a list of activitylog events | GET integrations.dixa.io/v1/conversations/activitylog/ |
GET dev.dixa.io/v1/conversations/activitylog |
| Get a list of activitylog events for a conversation | GET integrations.dixa.io/v1/conversations/{csid}/activitylog |
GET dev.dixa.io/v1/conversations/{conversationId}/activitylog |
| Add a historical message to a conversation | POST integrations.dixa.io/v1/conversations/{csid}/messages/historical |
POST dev.dixa.io/v1/conversations/{conversationId}/messages |
| Create a conversation | POST integrations.dixa.io/v1/conversations |
POST dev.dixa.io/v1/conversations |
| Get a list of internal notes of a conversation | GET integrations.dixa.io/v1/conversations/{csid}/notes |
GET dev.dixa.io/v1/conversations/{conversationId}/notes |
| Get a list of messages within a conversation | GET integrations.dixa.io/v1/conversations/{csid}/messages |
GET dev.dixa.io/v1/conversations/{conversationId}/messages |
| Get a single conversation by id | GET integrations.dixa.io/v1/conversations/{csid} |
GET dev.dixa.io/v1/conversations/{conversationId} |
Anonymization
| Name | Integrations API | Dixa API |
|---|---|---|
| Get anonymization request for specified id | GET integrations.dixa.io/v1/anonymization_request/{requestId} |
GET dev.dixa.io/v1/anonymization/request/{requestId} |
| Schedule anonymization for specified entity | POST integrations.dixa.io/v1/anonymization_request |
PATCH dev.dixa.io/v1/conversations/{conversationId}/anonymizePATCH dev.dixa.io/v1/conversations/{conversationId}/messages/{messageId}/anonymizePATCH dev.dixa.io/v1/endusers/{userId}/anonymize |
Endpoints
| Name | Integrations API | Dixa API |
|---|---|---|
| Get a list of endpoints | GET integrations.dixa.io/v1/endpoints |
GET dev.dixa.io/v1/contact-endpoints |
| Get an endpoint by id | GET integrations.dixa.io/v1/endpoints/{id} |
GET dev.dixa.io/v1/contact-endpoints/{contactEndpointId} |
Flows
| Name | Integrations API | Dixa API |
|---|---|---|
| List the current flows for an organization | GET integrations.dixa.io/v1/flows |
GET dev.dixa.io/v1/conversations/flows |
Queues
| Name | Integrations API | Dixa API |
|---|---|---|
| Get a list of queues for your organization | GET integrations.dixa.io/v1/queues |
GET dev.dixa.io/v1/queues |
| Get a queue by id | GET integrations.dixa.io/v1/queues/{id} |
GET dev.dixa.io/v1/queues/{queueId} |
Tags
| Name | Integrations API | Dixa API |
|---|---|---|
| Get a list of tags | GET integrations.dixa.io/v1/tags |
GET dev.dixa.io/v1/tags |
Users
| Name | Integrations API | Dixa API |
|---|---|---|
| Create a user | POST integrations.dixa.io/v1/users |
POST dev.dixa.io/v1/endusers |
| Returns a list of conversations requested by a specific user | GET integrations.dixa.io/v1/users/{userId}/requested_conversations |
GET dev.dixa.io/v1/endusers/{userId}/conversations |
| Returns a list of users | GET integrations.dixa.io/v1/user |
GET dev.dixa.io/v1/endusersGET dev.dixa.io/v1/agents |
| Return a single user | GET integrations.dixa.io/v1/user{userID} |
GET dev.dixa.io/v1/endusers/{userId}GET dev.dixa.io/v1/agents/{agentId} |