View as Markdown
Pidj icon

Pidj ACTION

Initiate Survey

Triggers a pre-configured text survey to a specific contact. Requires the contact's information and the survey ID. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Pidj account once, then configure and run Initiate Survey from your backend or agent.

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: "pidj-initiate-survey",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pidj: { authProvisionId: "apn_xxxxxxx" },
    surveyId: "Survey ID",
    contactId: "Contact ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Initiate Survey inputs
Property Type Description
surveyId Survey ID string
The ID of the survey to be triggered.
Required Dynamic
contactId Contact ID string
The ID of the contact.
Required Dynamic
fromNumber From Number string
Phone number to send from; this will determine which group the message sends from, and must be an active number from one of your groups. This must be in E.164 format, e.g., +18885552222
Optional
groupId Group Id string
The Id of the group.
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
pidj-initiate-survey
Version
0.0.2
App
Pidj
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes