CONNECT APP
Build with Superdocu
CRM
- API key
MCP
Give your agent Superdocu tools
Every Superdocu 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 Superdocu 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": "superdocu",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Contact:
const result = await mcp.callTool({
name: "superdocu-create-contact",
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": "superdocu",
}
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 Contact:
result = await session.call_tool("superdocu-create-contact", {
"firstName": "First Name",
"lastName": "Last Name",
})API PROXY
Call the Superdocu API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Superdocu 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.superdocu.com/api/v1/contacts",
})
// Any allowed Superdocu 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.superdocu.com/api/v1/contacts
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuc3VwZXJkb2N1LmNvbS9hcGkvdjEvY29udGFjdHM?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Superdocu actions from your backend
Connect a user's Superdocu account once, then run Create Contact 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: "superdocu-create-contact",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
superdocu: { 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="superdocu-create-contact",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"superdocu": {"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": "superdocu-create-contact",
"configured_props": {
"superdocu": { "authProvisionId": "apn_xxxxxxx" },
"firstName": "First Name",
"lastName": "Last Name"
}
}'TOOLS
Superdocu actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Contact
actionCreate a new contact in Superdocu. Returns the created contact including itsid, which you can then pass as contactId to Create Dossier to assign a workflow. See the documentation.Writev0.0.2 -
Create Dossier
actionCreate a dossier by assigning a workflow to an existing Superdocu contact (the API calls this acontact workflow). Run List Contacts (or Create Contact) first to obtain a contactId, and List Templates to obtain a workflowId. Returns the created dossier with itsidand initialstatus. The API returns 422 if the workflow is disabled, or 409 if a non-repeatable workflow is already assigned. See the documentation.Writev0.0.2 -
Delete Dossier
actionPermanently delete a dossier (the API calls this acontact workflow) from a contact. This is irreversible. Run List Contacts first to obtain a contactId, then List Dossiers for that contact to obtain a contactWorkflowId. See the documentation.Writev0.0.2 -
Get Dossier
actionRetrieve the full detail of a single dossier (the API calls this acontact workflow), including its states. Run List Contacts first to obtain a contactId, then List Dossiers for that contact to obtain a contactWorkflowId. See the documentation.Read-onlyv0.0.2 -
Invite Contact
actionInvite a Superdocu contact: emails them an invitation covering ALL workflows currently assigned to them. The Superdocu API endpoint takes only acontactIdand dispatches notifications for every assigned workflow — it is not possible to invite to a single dossier in isolation. Run List Contacts first to obtain a valid contactId. See the documentation.Writev0.0.2 -
List Contacts
actionList contacts in Superdocu. Returns an array of contact objects, each with a numericid(e.g."56031") — thisid(not the email) is the value to pass as contactId to List Dossiers, Create Dossier, Get Dossier, Delete Dossier, and Invite Contact. Theemailfield is for reference/display only; downstream tools do not accept it. Supports filtering by status, free-text query, tag, and assignee. See the documentation.Read-onlyv0.0.2 -
List Dossiers
actionList the dossiers (the API calls thesecontact workflows) assigned to a specific Superdocu contact. Returns an array of dossier objects, each with anid(the contact-workflow ID) and astatus. Run List Contacts first to obtain a valid contactId. Use a returned dossieridas the contactWorkflowId input to Get Dossier or Delete Dossier. See the documentation.Read-onlyv0.0.2 -
List Templates
actionList workflow templates in Superdocu (the API calls theseworkflows; the intake refers to them as templates). Returns an array of template objects, each with anidandname. Use the returnedidas the workflowId input to Create Dossier. See the documentation.Read-onlyv0.0.2
EVENTS
Superdocu triggers
Event sources your backend can deploy for users and receive through a webhook.
- App slug
- superdocu
- Authentication
- API key
- Categories
- CRM
- Actions
- 8
- Triggers
- 1
- API proxy
- Available