View as Markdown
Ongage icon

Ongage ACTION

Ongage Subscribe

Subscribe to a list in Ongage.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ongage account once, then configure and run Ongage Subscribe 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: "ongage-subscribe",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ongage: { authProvisionId: "apn_xxxxxxx" },
    listId: "List ID",
    email: "Email Address",
  },
})

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.

Ongage Subscribe inputs
Property Type Description
listId List ID string
Optional Dynamic
email Email Address string
Required
fields List Fields object
Optional
overwrite Overwrite? boolean
Whether to overwrite the specified fields if the subscriber already exists. Only the fields specified will be overwritten. For more information, see the Ongage API documentation
Required
haltOnError Halt on error? boolean
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
ongage-subscribe
Version
0.0.2
App
Ongage
Authentication
API key
Behavior
May modify external data