CONNECT APP
Build with PersistIQ
Marketing
- API key
MCP
Give your agent PersistIQ tools
Every PersistIQ 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 PersistIQ 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": "persistiq",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Add Do Not Contact Domain:
const result = await mcp.callTool({
name: "persistiq-add-do-not-contact-domain",
arguments: {
name: "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": "persistiq",
}
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 Add Do Not Contact Domain:
result = await session.call_tool("persistiq-add-do-not-contact-domain", {
"name": "Name",
})API PROXY
Call the PersistIQ API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the PersistIQ 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.persistiq.com/v1/users",
})
// Any allowed PersistIQ 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.persistiq.com/v1/users
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkucGVyc2lzdGlxLmNvbS92MS91c2Vycw?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run PersistIQ actions from your backend
Connect a user's PersistIQ account once, then run Add Do Not Contact Domain 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: "persistiq-add-do-not-contact-domain",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
persistiq: { authProvisionId: "apn_xxxxxxx" },
name: "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="persistiq-add-do-not-contact-domain",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"persistiq": {"authProvisionId": "apn_xxxxxxx"},
"name": "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": "persistiq-add-do-not-contact-domain",
"configured_props": {
"persistiq": { "authProvisionId": "apn_xxxxxxx" },
"name": "Name"
}
}'TOOLS
PersistIQ actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add Do Not Contact Domain
actionCreates a new DNC domain. See docs hereWritev0.0.2 -
Add Prospect To Campaign
actionAdds prospect to a campaign. See docs hereWritev0.0.2 -
Create Or Update Prospect
actionCreates a prospect. Updates if there is already a prospect with the givenemail. See docs hereWritev0.0.2
EVENTS
PersistIQ triggers
Event sources your backend can deploy for users and receive through a webhook.
- App slug
- persistiq
- Authentication
- API key
- Categories
- Marketing
- Actions
- 3
- Triggers
- 1
- API proxy
- Available