CONNECT APP
Build with Click2Mail
Business Management
- API key
MCP
Give your agent Click2Mail tools
Every Click2Mail 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 Click2Mail 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": "click2mail2",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Document:
const result = await mcp.callTool({
name: "click2mail2-create-document",
arguments: {
documentName: "Document Name",
documentFormat: "Document Format",
},
})# 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": "click2mail2",
}
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 Create Document:
result = await session.call_tool("click2mail2-create-document", {
"documentName": "Document Name",
"documentFormat": "Document Format",
})API PROXY
Call the Click2Mail API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Click2Mail 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 Click2Mail 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://api.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Click2Mail actions from your backend
Connect a user's Click2Mail account once, then run Create 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: "click2mail2-create-document",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
click2mail2: { authProvisionId: "apn_xxxxxxx" },
documentName: "Document Name",
documentFormat: "Document Format",
},
})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="click2mail2-create-document",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"click2mail2": {"authProvisionId": "apn_xxxxxxx"},
"documentName": "Document Name",
"documentFormat": "Document Format",
},
)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": "click2mail2-create-document",
"configured_props": {
"click2mail2": { "authProvisionId": "apn_xxxxxxx" },
"documentName": "Document Name",
"documentFormat": "Document Format"
}
}'TOOLS
Click2Mail actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Document
actionCreates a new document in your account from an uploaded file or a URL. See the documentation for file. See the documentation for URLWritev1.0.3 -
Create Job
actionCreates a new new job in your account. See the documentation.Writev0.0.3 -
List Address Id Options
actionRetrieves available options for the Address Id field.Read-onlyv0.0.1 -
List Document Id Options
actionRetrieves available options for the Document Id field.Read-onlyv0.0.1 -
List Project ID Options
actionRetrieves available options for the Project ID field.Read-onlyv0.0.1
EVENTS
Click2Mail triggers
Event sources your backend can deploy for users and receive through a webhook.
No Click2Mail triggers are available yet.
- App slug
- click2mail2
- Authentication
- API key
- Categories
- Business Management
- Actions
- 5
- Triggers
- 0
- API proxy
- Available