First-party app
OneSignal

OneSignal

Send push, email, and SMS messages, manage Users, Subscriptions, and Segments, and track custom events via the OneSignal REST API.

stable CommunicationMarketing

About

OneSignal ships in the w6w first-party pack. It declares 19 actions, 2 health checks, and the host runs its code in a sandbox that never sees the credential.

App id
io.w6w.onesignal
Version
0.1.0
Author
w6w
Licence
MIT
Categories
Communication · Marketing

Overview

OneSignal is a customer messaging and engagement platform: push notifications (mobile and web), email, SMS, and in-app messages, targeted at Users, Subscriptions, or Segments and orchestrated through Journeys.

This app covers the app-scoped REST surface a backend integration needs: sending a message on any channel (push, email, SMS) with segment, alias, subscription-id, or property-filter targeting; estimating a send’s audience before it goes out; reading, listing, and cancelling messages; creating, reading, updating, and deleting Users and their Subscriptions; creating, listing, and deleting Segments; and recording custom events that drive Journeys and segmentation.

Authentication is the App API key OneSignal introduced in November 2024 (os_v2_app_...), scoped to one App ID — the legacy REST API key and User Auth key still work but their management UI is gone and no new ones can be created, so this app is built against the current key only. Health checks track OneSignal’s own status page alongside the credential’s liveness; OneSignal exposes no readable API rate-limit headroom, which is declared rather than guessed at.

Build with OneSignal

Three routes to the same 19 actions. The Workflow tab is generated from OneSignal's own manifest and carries its real ids, so it is copy-pasteable; the Code and CLI examples are the same call for any action on any app, so every app-specific value in them is a blank you fill in.

Cancel Message

cancel-message

Stop a scheduled or currently-outgoing message.

Create Custom Event

create-custom-event

Record a custom event for a user, to trigger Journeys or drive segmentation.

Create Segment

create-segment

Define a new Segment from a filter expression.

Create Subscription

create-subscription

Attach an email, phone number, or push token to a user.

Create User

create-user

Create a user, optionally with an External ID, tags, and subscriptions.

Delete Segment

delete-segment

Delete a Segment. Does not delete users or subscriptions in it.

Delete Subscription

delete-subscription

Remove a Subscription from its user.

Delete User

delete-user

Permanently remove a user and all associated properties and subscriptions.

Estimate Recipients

estimate-recipients

Preview the audience size for a targeting configuration before sending.

Send Email

send-email

Send a transactional or promotional email to segments, aliases, or a filter.

Send Push Notification

send-push

Send a push notification to segments, subscriptions, aliases, or a filter.

Send SMS

send-sms

Send an SMS or MMS message to segments, subscriptions, aliases, or a filter.

Update Subscription

update-subscription

Update a Subscription's token, enabled state, or opt-in status.

Update User

update-user

Set a user's tags/language/timezone, and optionally increment usage deltas.

Get App

view-app

Read this app's non-secret configuration and channel settings.

Get Message

view-message

Retrieve delivery stats and content for one message.

List Messages

view-messages

List messages sent from this app, most recent first.

List Segments

view-segments

List the Segments defined for this app.

Get User

view-user

Retrieve a user including aliases, properties, and subscriptions.

A workflow step names the app and the action, and the editor fills in the connection when you pick one. This is the Step shape from the workflow spec, carrying OneSignal's real ids.

{
  "manifestVersion": "2",
  "name": "onesignal-example",
  "steps": [
    {
      "id": "create-custom-event",
      "uses": {
        "app": "io.w6w.onesignal",
        "action": "create-custom-event",
        "connection": "conn_YOUR_CONNECTION_ID"
      },
      "with": {
        "name": "<name>"
      }
    }
  ]
}

Here are some of the things you can do

  • Create Custom Event

    perform
    create-custom-event
  • Create Segment

    perform
    create-segment
  • Create Subscription

    perform
    create-subscription
  • Create User

    perform
    create-user
  • Estimate Recipients

    read
    estimate-recipients

+14 more actions available

Every app-specific value here is a blank you have to fill in. An app action is reached through the connection that authenticates it, so the address is a connection id, not the app id — and connections belong to your account, so a public page cannot know yours. Create one for OneSignal, then fill in the three blanks: conn_YOUR_CONNECTION_ID, the action key, and the parameters that action declares. The call itself is real — the shape is transcribed from the studio's own snippet builder, which prints the same kind of blanks — but nothing in it is specific to OneSignal. The Workflow tab is where this app's real ids are.

Install
npm install @w6w/sdk
yarn add @w6w/sdk
pnpm add @w6w/sdk
deno add npm:@w6w/sdk
Code
import { W6wClient, isActionRun } from "@w6w/sdk";

// Reads W6W_BASE_URL and W6W_TOKEN from the environment when omitted.
const client = new W6wClient();

const envelope = await client.run({
  urn: "conn_YOUR_CONNECTION_ID",
  action: "create-custom-event",
  payload: {
    name: "<value>",
    // externalId: "<value>",
    // onesignalId: "<value>",
    // properties: "<value>",
    // timestamp: "<value>",
    // idempotencyKey: "<value>",
  },
});

if (isActionRun(envelope)) console.log(envelope.value);
Install the CLI
npm install -g @w6w/cli
CLI
w6w run conn_YOUR_CONNECTION_ID --action create-custom-event --payload '{"name":"<value>"}'

Give an AI agent OneSignal — without giving it OneSignal's credentials. One MCP endpoint exposes every app, function and workflow the caller is entitled to, as tools it can discover and run. Access is granted per team while we onboard.

One tool call
{
  "name": "w6w_invoke",
  "arguments": {
    "ref": "app:io.w6w.onesignal#create-custom-event",
    "input": {
      "name": "<name>"
    }
  }
}

Every tool names its target with a single ref. The app: form above doesn't name a connection at all — the host resolves which of the caller's OneSignal connections to sign with, and refuses rather than guesses when the answer is ambiguous.

What the agent gets

Credentials it can't read

The token is attached host-side, at the moment of the call. It is never a tool argument, never in the model's context, and never in a transcript — so a prompt injection has nothing to exfiltrate.

A tool surface scoped to the caller

Tools are derived per end user from what that person has actually connected and is entitled to — not one shared bot identity carrying the union of everyone's access.

A durable workflow in one call

Multi-step work runs on the workflow engine and returns a run handle the agent can poll — retries, branching and state survive the conversation that started them.

Health-aware discovery

OneSignal's declared health checks are on the surface too, so an agent can tell "the vendor is down" from "your credential expired" before it burns a retry on either.

The MCP surface is part of the hosted platform. OneSignal itself is MIT, and the runtime that executes it is source-available (FSL).

Request MCP access

Health checks

OneSignal declares its own checks, so its health is a property of the app rather than something the host guesses at.

service

OneSignal platform status

Component status from status.onesignal.com — Push, Email, SMS, In-App Messages, Journeys, Integrations, Analytics & Reporting, APIs & SDK Endpoints, and Dashboard / UI.

quota

API rate-limit headroom