UltraMsg icon

CONNECT APP

Build with UltraMsg

Ultramsg is a WhatsApp API provider and a gateway for working with messages.

Communication

  • API key

MCP

Give your agent UltraMsg tools

Every UltraMsg 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 UltraMsg 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": "ultramsg",
      },
    },
  },
)

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

const { tools } = await mcp.listTools()

// e.g. run Send a Document:
const result = await mcp.callTool({
  name: "ultramsg-send-document",
  arguments: {
    to: "To",
    document: "Document",
  },
})

API PROXY

Call the UltraMsg API directly

For an endpoint with no pre-built tool, the Connect proxy forwards your request to the UltraMsg 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://api.example.com/v1/me",
})

// Any allowed UltraMsg endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.

SDK

Run UltraMsg actions from your backend

Connect a user's UltraMsg account once, then run Send a Document 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: "ultramsg-send-document",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ultramsg: { authProvisionId: "apn_xxxxxxx" },
    to: "To",
    document: "Document",
  },
})

EVENTS

UltraMsg triggers

Event sources your backend can deploy for users and receive through a webhook.

No UltraMsg triggers are available yet.

MULTI-APP

Use UltraMsg with other popular apps

Most products don't stop at one integration. Pair UltraMsg with the other apps your users rely on, and ship use cases that span both.

REFERENCE

App details

Reference metadata for the UltraMsg connector in the Pipedream registry.

App slug
ultramsg
Authentication
API key
Categories
Communication
Actions
7
Triggers
0
API proxy
Available