View as Markdown
Nudgify icon

Nudgify ACTION

Create Purchase Nudge

Creates a purchase nudge. See docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Nudgify account once, then configure and run Create Purchase Nudge 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: "nudgify-create-purchase-nudge",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    nudgify: { authProvisionId: "apn_xxxxxxx" },
    orderId: 10,
    items: ["Items"],
  },
})

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 Purchase Nudge inputs
Property Type Description
orderId Order ID integer
The order-id used to identify which items are part of the same order
Required
items Items string[]
One or more items as part of the purchase. Each item should be a JSON string and can contain the parameters item_id, item_variation_id, item_name, item_link and image_url. See the documentation for more information.
Optional
date Date string
The date (UTC) used to show in the Nudge how long ago the conversion took place. Format: YYYY-MM-DD HH:MM:SS (example: 2021-04-15 04:29:42)
Required
email Email string
The email address of the user
Required
firstName First Name string
The first name of the user
Optional
lastName Last Name string
The last name of the user
Optional
ip IP Address string
The IP address of the user
Optional
city City string
The city of the user
Optional
state State string
The state of the user
Optional
country Country string
The country of the user (max 2 characters, e.g. GB, US)
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
nudgify-create-purchase-nudge
Version
0.0.2
App
Nudgify
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes