View as Markdown
Dixa icon

Dixa ACTION

Create Conversation

Creates a new email or contact form-based conversation. 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 Create 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-create-conversation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    dixa: { authProvisionId: "apn_xxxxxxx" },
    requesterId: "Requester Id",
    direction: "Direction",
  },
})

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.

Create Conversation inputs
Property Type Description
requesterId Requester Id string
The id of the end user.
Required Dynamic
direction Direction string
The direction of the message
Required
channel Channel string
For outbound, only Email is supported. Inbound also supports ContactForm.
Required
emailIntegrationId Email Integration ID string
The contact endpoint in the organization.
Required Dynamic
subject Subject string
The subject of the conversation
Required
message Message string
The content message.
Required
language Language string
The 2-letter ISO 639-1 language of the conversation
Optional
agentId Agent Id string
The id of the agent.
Optional Dynamic

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-create-conversation
Version
0.0.4
App
Dixa
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes