OneSignal (REST API) icon

CONNECT APP

Build with OneSignal (REST API)

Push messaging

CRM

  • API key

MCP

Give your agent OneSignal (REST API) tools

Every OneSignal (REST API) action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's OneSignal (REST API) account for each tool call — you store no tokens.

// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": "{project_id}",
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "onesignal_rest_api",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Add Device:
const result = await mcp.callTool({
  name: "onesignal_rest_api-add-device",
  arguments: {
    deviceType: "Device Type",
    identifier: "Identifier",
  },
})

API PROXY

Call the OneSignal (REST API) API directly

For an endpoint with no pre-built tool, the Connect proxy forwards your request to the OneSignal (REST API) API with the connected user's credentials attached. You store no tokens and write no refresh logic.

const resp = await pd.proxy.get({
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  accountId: "apn_xxxxxxx",
  url: "https://api.example.com/v1/me",
})

// Any allowed OneSignal (REST API) endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.

SDK

Run OneSignal (REST API) actions from your backend

Connect a user's OneSignal (REST API) account once, then run Add Device on their behalf from your own code — TypeScript, Python, or plain HTTP.

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: "onesignal_rest_api-add-device",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    onesignal_rest_api: { authProvisionId: "apn_xxxxxxx" },
    deviceType: "Device Type",
    identifier: "Identifier",
  },
})

EVENTS

OneSignal (REST API) triggers

Event sources your backend can deploy for users and receive through a webhook.

No OneSignal (REST API) triggers are available yet.

REFERENCE

App details

Reference metadata for the OneSignal (REST API) connector in the Pipedream registry.

App slug
onesignal_rest_api
Authentication
API key
Categories
CRM
Actions
4
Triggers
0
API proxy
Available