View as Markdown
SurveySparrow icon

SurveySparrow ACTION

Share NPS Survey via SMS

Sends a saved NPS share template via SMS to given mobile number recipients. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SurveySparrow account once, then configure and run Share NPS Survey via SMS 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: "surveysparrow-share-nps-survey-sms",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    surveysparrow: { authProvisionId: "apn_xxxxxxx" },
    survey: "Survey",
    name: "Name",
  },
})

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.

Share NPS Survey via SMS inputs
Property Type Description
survey Survey string
Identifier of a survey
Required Dynamic
name Name string
Name of the channel.
Required
mode Mode string
Mode of the channel.
Optional
sms SMS message string
Message of sms, both {company_name} and {survey_link} variables are required.
Required

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
surveysparrow-share-nps-survey-sms
Version
0.0.2
App
SurveySparrow
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes