View as Markdown
Pingback icon

Pingback ACTION

Create Subscriber

Create a new subscriber See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Pingback account once, then configure and run Create Subscriber 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: "pingback-create-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pingback: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    phone: "Phone",
  },
})

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.

Create Subscriber inputs
Property Type Description
email Email string
The email address of the subscriber
Required
phone Phone string
The phone number of the subscriber. Must be in E.164 format. E.g. +1234567890
Optional
name Name string
The name of the subscriber
Optional
status Status string
The status of the subscriber
Optional
customFields Custom Fields object
Custom fields for the subscriber
Optional
segmentationLists Segmentation Lists string[]
Segmentation lists to add the subscriber to. You can get the ID by clicking audience and lists at Pingback dashboard.
Optional

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
pingback-create-subscriber
Version
0.0.2
App
Pingback
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes