View as Markdown
Starloop icon

Starloop ACTION

Send Invite

Creates a new recipient and sends a Starloop invite (Email | SMS | both) to your customer to leave a review. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Starloop account once, then configure and run Send Invite 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: "starloop-send-invite",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    starloop: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    email: "Email",
  },
})

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.

Send Invite inputs
Property Type Description
firstName First Name string
The first name of the recipient
Required
email Email string
The email of the recipient
Optional
phone Phone string
The phone number of the recipient
Optional
businessId Business ID string
The ID of the business
Optional Dynamic
profileId Profile ID string
The ID of the profile
Optional Dynamic
testMode Test Mode boolean
If set to true, the invite will not be sent
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
starloop-send-invite
Version
0.0.2
App
Starloop
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes