CONNECT APP
Build with White Swan
Commerce
- API key
MCP
Give your agent White Swan tools
Every White Swan 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 White Swan 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": "white_swan",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Pre-fill Info:
const result = await mcp.callTool({
name: "white_swan-create-pre-fill-info",
arguments: {
firstName: "First Name",
lastName: "Last Name",
},
})# 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": "white_swan",
}
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 Pre-fill Info:
result = await session.call_tool("white_swan-create-pre-fill-info", {
"firstName": "First Name",
"lastName": "Last Name",
})API PROXY
Call the White Swan API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the White Swan 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://app.whiteswan.io/api/1.1/wf/plan_requests",
})
// Any allowed White Swan 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://app.whiteswan.io/api/1.1/wf/plan_requests
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcHAud2hpdGVzd2FuLmlvL2FwaS8xLjEvd2YvcGxhbl9yZXF1ZXN0cw?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run White Swan actions from your backend
Connect a user's White Swan account once, then run Create Pre-fill Info 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: "white_swan-create-pre-fill-info",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
white_swan: { authProvisionId: "apn_xxxxxxx" },
firstName: "First Name",
lastName: "Last Name",
},
})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="white_swan-create-pre-fill-info",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"white_swan": {"authProvisionId": "apn_xxxxxxx"},
"firstName": "First Name",
"lastName": "Last Name",
},
)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": "white_swan-create-pre-fill-info",
"configured_props": {
"white_swan": { "authProvisionId": "apn_xxxxxxx" },
"firstName": "First Name",
"lastName": "Last Name"
}
}'TOOLS
White Swan actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Pre-fill Info
actionImports client data for pre-filling applications to enrich the user experience. See the documentationWritev0.0.2 -
Get Referred Clients Info
actionRetrieves information about clients referred from the user's White Swan account. See the documentationRead-onlyv0.0.2 -
List Client Email Options
actionRetrieves available options for the Client Email field.Read-onlyv0.0.1 -
Submit Complete Plan Request
actionCreates a new comprehensive quote request based on the information provided and generates the final quotation without further data requirements. See the documentationWritev0.0.3
EVENTS
White Swan triggers
Event sources your backend can deploy for users and receive through a webhook.
- App slug
- white_swan
- Authentication
- API key
- Categories
- Commerce
- Actions
- 4
- Triggers
- 2
- API proxy
- Available