CONNECT APP
Build with OneSignal (REST API)
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",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"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",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Add Device:
result = await session.call_tool("onesignal_rest_api-add-device", {
"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.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"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",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="onesignal_rest_api-add-device",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"onesignal_rest_api": {"authProvisionId": "apn_xxxxxxx"},
"deviceType": "Device Type",
"identifier": "Identifier",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "onesignal_rest_api-add-device",
"configured_props": {
"onesignal_rest_api": { "authProvisionId": "apn_xxxxxxx" },
"deviceType": "Device Type",
"identifier": "Identifier"
}
}'TOOLS
OneSignal (REST API) actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
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