View as Markdown
Dixa icon

Dixa ACTION

Claim Conversation

Claims a conversation for a given agent. To avoid taking over assigned conversations, set the force parameter to false. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Dixa account once, then configure and run Claim Conversation from your backend or agent.

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-claim-conversation",
  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",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Claim Conversation inputs
Property Type Description
endUserId End User Id string
The id of the end user.
Required Dynamic
conversationId Conversation ID string
The ID of the conversation
Required Dynamic
agentId Agent Id string
The ID of the agent who is claiming the conversation.
Required Dynamic
force Force boolean
Set as false to avoid taking over the conversation if it is already assigned to an agent.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
dixa-claim-conversation
Version
0.0.2
App
Dixa
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes