CONNECT APP
Build with Dixa
The CX Platform for Consumer Brands
CRM
- API key
MCP
Give your agent Dixa tools
Every Dixa action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Dixa account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "dixa",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Add Message to Conversation:
const result = await mcp.callTool({
name: "dixa-add-message",
arguments: {
endUserId: "End User Id",
conversationId: "Conversation ID",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "dixa",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Add Message to Conversation:
result = await session.call_tool("dixa-add-message", {
"endUserId": "End User Id",
"conversationId": "Conversation ID",
})API PROXY
Call the Dixa API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Dixa API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://dev.dixa.io/v1/agents",
})
// Any allowed Dixa endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://dev.dixa.io/v1/agents
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9kZXYuZGl4YS5pby92MS9hZ2VudHM?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Dixa actions from your backend
Connect a user's Dixa account once, then run Add Message to Conversation on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "dixa-add-message",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
dixa: { authProvisionId: "apn_xxxxxxx" },
endUserId: "End User Id",
conversationId: "Conversation ID",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="dixa-add-message",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"dixa": {"authProvisionId": "apn_xxxxxxx"},
"endUserId": "End User Id",
"conversationId": "Conversation ID",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "dixa-add-message",
"configured_props": {
"dixa": { "authProvisionId": "apn_xxxxxxx" },
"endUserId": "End User Id",
"conversationId": "Conversation ID"
}
}'TOOLS
Dixa actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add Message to Conversation
actionAdds a message to an existing conversation. See the documentation.Writev0.0.4 -
Add Tag to Conversation
actionAdds a tag to a conversation. See the documentationWritev0.0.4 -
Claim Conversation
actionClaims a conversation for a given agent. To avoid taking over assigned conversations, set the force parameter to false. See the documentationWritev0.0.2 -
Close Conversation
actionMark a conversation as closed by providing its id. See the documentationWritev0.0.1 -
Create Conversation
actionCreates a new email or contact form-based conversation. See the documentation.Writev0.0.4 -
Create Note
actionCreates an internal note for a conversation. See the documentation.Writev0.0.1 -
Get Article
actionGet an article from Dixa. See the documentationRead-onlyv0.0.2 -
Get Article Translations
actionGet the translations of an article from Dixa. See the documentationRead-onlyv0.0.2 -
Get Conversation
actionGets a conversation. See the documentationRead-onlyv0.0.1 -
List Agent Id Options
actionRetrieves available options for the Agent Id field.Read-onlyv0.0.1 -
List Email Integration ID Options
actionRetrieves available options for the Email Integration ID field.Read-onlyv0.0.1 -
List End User Id Options
actionRetrieves available options for the End User Id field.Read-onlyv0.0.1 -
List Messages
actionLists messages from a conversation. See the documentation.Read-onlyv0.0.1 -
List Notes
actionLists internal notes from a conversation. See the documentation.Read-onlyv0.0.1 -
List Tag ID Options
actionRetrieves available options for the Tag ID field.Read-onlyv0.0.1 -
Set Custom Contact Attributes
actionUpdates custom attributes for a specified user. See the documentationWritev0.0.4
-
New Conversation Created (Instant)
triggerEmit new event when a conversation is created in Dixa. See the documentation.Instantv0.0.3 -
New Conversation Status Changed (Instant)
triggerEmit new events when the status of a conversation changes (e.g., open, closed, or abandoned). See the documentation.Instantv0.0.3 -
New Customer Satisfaction Rating (Instant)
triggerEmit new event when a customer submits a satisfaction rating for a conversation. See the documentation.Instantv0.0.3 -
New Message Added to Conversation (Instant)
triggerEmit new event when a new message is added to a conversation. See the documentation.Instantv0.0.3 -
New Tag Added in Conversation (Instant)
triggerEmit new event when a tag is added to a conversation. See the documentation.Instantv0.0.3
- App slug
- dixa
- Authentication
- API key
- Categories
- CRM
- Actions
- 16
- Triggers
- 5
- API proxy
- Available