# Join Conversation — Sunshine Conversations

> Join a conversation. See the documentation

- Key: `sunshine_conversations-join-conversation`
- Type: Action (Write)
- Version: 0.0.3
- App: Sunshine Conversations (`sunshine_conversations`) — https://pipedream.com/apps/sunshine-conversations.md
- This page (HTML): https://pipedream.com/apps/sunshine-conversations/actions/join-conversation
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/sunshine_conversations/actions/join-conversation/join-conversation.mjs

## Description

Join a conversation. [See the documentation](https://developer.zendesk.com/api-reference/conversations/#tag/Conversations/operation/JoinConversation)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `userId` | `string` | Yes | The ID of the user received from your Conversations Webhook to filter conversations. |
| `conversationId` | `string` | Yes | The ID of the conversation to get messages for. Options are loaded from the connected account. |
| `newUserId` | `string` | Yes | The ID of the user to join the conversation |
| `subscribeSDKClient` | `boolean` | Yes | When passed as true, the SDK client of the concerned participant will be subscribed to the conversation. The user will start receiving push notifications for this conversation right away, without having to view the conversation on the SDK beforehand. An SDK client will be created for users that don’t already have one. This field is required if the conversation is of type sdkGroup |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "sunshine_conversations",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "sunshine_conversations-join-conversation",
  arguments: {
    userId: "User ID",
    conversationId: "Conversation ID",
  },
})
```

**TypeScript**

```ts
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: "sunshine_conversations-join-conversation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sunshine_conversations: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    conversationId: "Conversation ID",
  },
})

console.log(result)
```

**cURL**

```bash
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": "sunshine_conversations-join-conversation",
    "configured_props": {
      "sunshine_conversations": { "authProvisionId": "apn_xxxxxxx" },
      "userId": "User ID",
      "conversationId": "Conversation ID"
    }
  }'
```

---

- App: https://pipedream.com/apps/sunshine-conversations.md · All apps: https://pipedream.com/apps