The OneSignal connector lets your AI agent act in each user's OneSignal account. Each user connects their own OneSignal API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 51 tools.
- Tools
- 51
- What they doRead · write · destructive
- 21 · 23 · 721 read23 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the OneSignal connection
In AgentKit > Connections, create an OneSignal connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'onesignal'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize OneSignal:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'onesignal_email_reputation_get',toolInput: { app_id: 'YOUR_APP_ID' },})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "onesignal"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize OneSignal:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={"app_id":"YOUR_APP_ID"},tool_name="onesignal_email_reputation_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their OneSignal credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolonesignal_email_provider_metrics_getGet email delivery, open, click, bounce, failure, and spam complaint counts for a sending domain, broken down by inbox provider.Read-onlyGet Email Inbox Provider Metrics
Get email delivery, open, click, bounce, failure, and spam complaint counts for a sending domain, broken down by inbox provider. Returns an object with providers.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
domainstringrequired- The sending domain to report on. Must be an email domain configured for this app. Example: mail.example.com
endstringrequired- End of the reporting window as an ISO 8601 timestamp, for example `2026-08-08T00:00:00Z`.
startstringrequired- Start of the reporting window as an ISO 8601 timestamp, for example `2026-08-01T00:00:00Z`. Must be before `end` and no more than 365 days ago.
onesignal_email_provider_metrics_timeseries_getGet email delivery, open, click, bounce, failure, and spam complaint counts for a sending domain over time, bucketed by hour, day, or month and totaled across the requested inbox providers.Read-onlyGet Email Inbox Provider Metrics Over Time
Get email delivery, open, click, bounce, failure, and spam complaint counts for a sending domain over time, bucketed by hour, day, or month and totaled across the requested inbox providers. Returns an object with events.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
domainstringrequired- The sending domain to report on. Must be an email domain configured for this app. Example: mail.example.com
endstringrequired- End of the reporting window as an ISO 8601 timestamp, for example `2026-08-08T00:00:00Z`.
granularitystringrequired- The size of each time bucket. `hourly` is only available for the last 60 days. Example: dailyone of
hourlydailymonthly startstringrequired- Start of the reporting window as an ISO 8601 timestamp, for example `2026-08-01T00:00:00Z`. Must be before `end` and no more than 365 days ago, or 60 days ago when `granularity` is `hourly`.
providers__array- Inbox providers to include in the totals. Repeat the parameter for each provider, for example `providers[]=gmail&providers[]=yahoo_us`. Omit to include all providers. Accepted values: `apple`, `att`, `canadian`, `chinese`, `comcast`, `free_fr`, `french`, `german`, `gmail`, `google_workspace`, `googlers`, `inbox_lv`, `italian`, `japanese`, `outlook_365`, `outlook_eu`, `outlook_us`, `proton`, `rackspace`, `russian`, `uk`, `united_online`, `yahoo_eu`, `yahoo_us`, `other_eu`, `other_us`, and `other`. Example: ["gmail"]
onesignal_email_reputation_getGet email bounce and spam complaint rates received for the app over the last 24 hours, 7 days, and 30 days.Read-onlyGet Email Reputation Statistics
Get email bounce and spam complaint rates received for the app over the last 24 hours, 7 days, and 30 days. Returns an object with last_24_hours, last_7_days, last_30_days.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
onesignal_journey_getRetrieve the full configuration of a single journey by its UUID, including its audience and node graph.Read-onlyView journey
Retrieve the full configuration of a single journey by its UUID, including its audience and node graph. Returns an object with id, app_id, name, description, state, created_at, updated_at, started_at, archived_at, created_source, audience, early_exit and more. Use this when you have the ID. Use onesignal_journeys_list to find one. Needs id from onesignal_journeys_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
idstringrequired- UUID of the journey to retrieve. Example: YOUR_JOURNEY_ID
onesignal_journey_schema_getRetrieve the JSON Schema for a Journey authoring operation without authentication or app context.Read-onlyGet Journey Schema
Retrieve the JSON Schema for a Journey authoring operation without authentication or app context. Returns an object with operation, document, schema.
Inputs
operationstringrequired- The authoring operation whose schema you need. Example: createone of
createduplicateupdateupdate_node
onesignal_journey_stats_getRetrieve performance stats for a single journey: journey-level entry and exit counts, per-node counts keyed by node `id`, per-branch counts keyed by branch `id`, and channel delivery stats for message-sending nodes.Read-onlyView journey stats
Retrieve performance stats for a single journey: journey-level entry and exit counts, per-node counts keyed by node `id`, per-branch counts keyed by branch `id`, and channel delivery stats for message-sending nodes. Returns an object with id, started, completed, exited_early, nodes, branches. Needs id from onesignal_journeys_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
idstringrequired- UUID of the journey to retrieve stats for. Example: YOUR_JOURNEY_ID
onesignal_journeys_listRetrieve a paginated list of journeys for an app.Read-onlyView journeys
Retrieve a paginated list of journeys for an app. Returns a summary representation of each journey; use View journey for the full configuration. Returns an object with journeys, has_more, next_cursor. Use this to browse. Use onesignal_journey_get when you already have the ID.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
cursorstring- Opaque pagination token from a previous response's `next_cursor`. Omit for the first page. Example: eyJpZCI6IjEyMyJ9
limitinteger- Maximum journeys to return per page. Minimum `1`, maximum `50`. Example: 50
onesignal_message_events_exportExport a compressed CSV report of audience-level delivery and engagement data for a specific message.Read-onlyExport Message Audience Activity
Export a compressed CSV report of audience-level delivery and engagement data for a specific message. Returns an object with csv_file_url. Needs message_id from onesignal_messages_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
message_idstringrequired- The identifier of the message in UUID v4 format. Get this `id` in the response of your Create Message API request, the View Messages API, and in your OneSignal dashboard Message Reports. Example: YOUR_NOTIFICATION_ID
onesignal_message_getView the details of a single message and the Outcomes associated with it.Read-onlyGet Message
View the details of a single message and the Outcomes associated with it. Returns an object with app_id, big_picture, canceled, chrome_web_icon, chrome_web_image, name, contents, converted, data, delayed_option, delivery_time_of_day, remaining and more. Use this when you have the ID. Use onesignal_messages_list to find one. Needs message_id from onesignal_messages_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
message_idstringrequired- The identifier of the message in UUID v4 format. Get this `id` in the response of your Create Message API request, the View Messages API, and in your OneSignal dashboard Message Reports. Example: Hello from Scalekit
outcome_attributionstring- Attribution type for the outcomes. Example: totalone of
directinfluencedunattributedtotal outcome_namesstring- The name and aggregation type of the outcome(s) you want to fetch. Example: `my_outcome.count` or `my_outcome.sum`. For clicks, use `os__click.count`. For confirmed deliveries, use `os__confirmed_delivery.count`. For session duration, use `os__session_duration.count`.
outcome_platformsstring- The platforms in which you want to pull the data represented as the `device_type` integer. Example: 0,1,2,5,8,11,14,17
outcome_time_rangestring- Time range for the returned data. Available values: `1h` (1 hour), `1d` (1 day), `1mo` (1 month) Example: 1hone of
1h1d1mo
onesignal_message_history_exportView which subscriptions received a particular message Returns an object with success, destination_url.Read-onlyExport Message History
View which subscriptions received a particular message Returns an object with success, destination_url. Needs message_id from onesignal_messages_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
eventsstringrequired- Specifies the type of event to retrieve. `sent` retrieves all subscriptions that were sent the specified message. Sent events are not recorded for messages targeting fewer than 1,000 recipients. `clicked` retrieves all subscriptions that interacted with the message. Clicked events have no recipient-count threshold. Example: sent
message_idstringrequired- The identifier of the message in UUID v4 format. Get this `id` in the response of your Create Message API request, the View Messages API, and in your OneSignal dashboard Message Reports. Example: Hello from Scalekit
emailstring- The email address in which to deliver the report. Example: jane@example.com
onesignal_message_recipients_estimateReturn the estimated number of recipients for a notification's targeting, without creating or sending anything.Read-onlyEstimate Message Recipients
Return the estimated number of recipients for a notification's targeting, without creating or sending anything. Returns an object with count, uncapped_count, cap_applied, mobile_suppressed, mobile_excluded_count.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
included_segmentsarrayrequired- Required. Segment names that define the base audience to count. Combine with `excluded_segments`, `filters`, `include_aliases`, and `target_channel` to narrow the estimate. Example: `["Active Users", "Inactive Users"]`. `"All"` is a shorthand for every subscribed user: if the array includes `"All"` and the app has no segment named All, the count includes all subscribers instead of looking up a segment named All.
excluded_segmentsarray- Segment names to exclude from the count. Users in these segments are omitted even if they appear in `included_segments`. Example: `["Active Users", "Inactive Users"]`.
filtersarray- Filter expressions that further narrow the audience to count. Each element is either a filter condition or an `AND`/`OR` operator. Example: [{"field": "tag", "key": "level", "relation": ">", "value": "10"}]
include_aliasesobject- Narrow the count to users identified by aliases (`external_id`, `onesignal_id`, or a custom alias). Keys are alias labels and values are arrays of alias IDs. Example: `{ "external_id": ["extId1", "extId2"] }`. Limit of 2,000 entries per REST API call.
target_channelstring- Which platforms to count recipients for. Selects the same default platforms Create notification would use for the channel. Individual platform flags (`isIos`, `isAndroid`, etc.) are not supported by this endpoint. Example: pushone of
pushemailsms
onesignal_messages_listView the details for a collection of messages.Read-onlyList Messages
View the details for a collection of messages. Returns notifications, an array of items with app_id, big_picture, canceled, chrome_web_icon, chrome_web_image, name, contents, converted, data, delayed_option, plus total_count, time_offset, next_time_offset, offset, limit. Use this to browse. Use onesignal_message_get when you already have the ID.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
kindinteger- Specifies which push notifications to return based on how it was created. Use this to segment push by their creation method, allowing for targeted analysis or management of notification types. All push types are returned by default. `0` - Notifications created through the dashboard. `1` - Notifications sent via API calls. `3` - Notifications triggered through automated systems. Example: 1
limitinteger- Specifies the maximum number of messages to return in a single query. The maximum and default is 50 messages per request. Example: 10
offsetinteger- Controls the starting point for the notifications being returned. Default is 0. Results are returned and sorted in descending order by `queued_at`. Example: 0
template_idstring- The template ID in UUID v4 format set for the message if applicable. See Templates. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
time_offsetstring- An ISO 8601 formatted timestamp or Base64 integer token (provided in the API response). See `time_offset` Accepted Values. Example: 2026-01-15T09:30:00Z
onesignal_outcomes_getView and export push notification outcome metrics such as clicks, conversions, and custom events.Read-onlyGet Outcomes
View and export push notification outcome metrics such as clicks, conversions, and custom events. Returns an object with outcomes.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
outcome_attributionstring- Attribution type for the outcomes. Example: totalone of
directinfluencedunattributedtotal outcome_namesstring- The name and aggregation type of the outcome(s) you want to fetch. Example: `my_outcome.count` or `my_outcome.sum`. For clicks, use `os__click.count`. For confirmed deliveries, use `os__confirmed_delivery.count`. For session duration, use `os__session_duration.count`.
outcome_platformsstring- The platforms in which you want to pull the data represented as the `device_type` integer. Example: 0,1,2,5,8,11,14,17
outcome_time_rangestring- Time range for the returned data. Available values: `1h` (1 hour), `1d` (1 day), `1mo` (1 month) Example: 1hone of
1h1d1mo
onesignal_segment_getRetrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters.Read-onlyView segment
Retrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters. Returns an object with subscriber_count, payload. Use this when you have the ID. Use onesignal_segments_list to find one. Needs segment_id from onesignal_segments_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
segment_idstringrequired- The segment's unique identifier. In the dashboard, go to Audience > Segments, open the segment's options menu, and select Copy segment ID. You can also get it from the View segments API or the segment's URL in the dashboard. Example: YOUR_SEGMENT_ID
include_segment_detailboolean- Set to `true` to include segment metadata and filters in the response. Example: false
onesignal_segments_listRetrieve a list of segments associated with a specific OneSignal app.Read-onlyView segments
Retrieve a list of segments associated with a specific OneSignal app. Returns segments, an array of items with id, name, description, created_at, updated_at, app_id, read_only, is_active, plus total_count, offset, limit. Use this to browse. Use onesignal_segment_get when you already have the ID.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
limitinteger- The maximum number of segments to return. Default/Max: `300`. Ideal for controlling data volume in large-scale applications. Example: 300
offsetinteger- The index to start returning segments from. Defaults to `0`. Segments are sorted by their creation date (`created_at`) in ascending order. Example: 0
onesignal_subscription_identity_getRetrieve all aliases linked to a user using a known `subscription_id`.Read-onlyGet User Identity by Subscription
Retrieve all aliases linked to a user using a known `subscription_id`. Returns an object with identity.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
subscription_idstringrequired- The unique Subscription ID in UUID v4 format generated by OneSignal. See Subscriptions. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
onesignal_subscriptions_exportGenerate a GZip-compressed CSV export of your current subscription data using this API endpoint.Read-onlyExport Subscriptions CSV
Generate a GZip-compressed CSV export of your current subscription data using this API endpoint. Returns an object with csv_file_url.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
extra_fieldsarray- Additional properties that you can include in the CSV. Example: ["external_user_id", "country", "timezone_id"]
include_unsubscribedboolean- When used with `segment_name`, set to `true` to include unsubscribed subscriptions in the export. By default, segment-filtered exports only return subscribed subscriptions. This parameter has no effect when `segment_name` is not provided. Example: false
last_active_sincestring- A Unix timestamp (in seconds) used to filter Subscriptions based on recent activity. Only Subscriptions with a `last_session` timestamp after this value will be included in the export. Example: To export Subscriptions active since January 1st, 2024, use `1704067200`.
segment_namestring- The name of a specific segment to filter the export. Only subscriptions that belong to this segment will be included in the CSV. Omit this field to export all subscriptions in the app. Example: Scalekit test
onesignal_template_getRetrieve the details of a specific message template in your OneSignal app using its template ID.Read-onlyView template
Retrieve the details of a specific message template in your OneSignal app using its template ID. Returns an object with id, name, channel, created_at, updated_at, content. Use this when you have the ID. Use onesignal_templates_list to find one. Needs template_id from onesignal_templates_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
template_idstringrequired- The template ID in UUID v4 format. See Templates. Example: YOUR_TEMPLATE_ID
onesignal_templates_listRetrieve a paginated list of message templates from your OneSignal app.Read-onlyView templates
Retrieve a paginated list of message templates from your OneSignal app. Returns templates, an array of items with id, name, created_at, updated_at, plus limit, offset, total_count. Use this to browse. Use onesignal_template_get when you already have the ID.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
channelstring- Filter the fetched templates by the delivery channel. Available options are: `push`, `email`, and `SMS`. Example: pushone of
pushemailsms limitinteger- The maximum number of templates returned per request. The default (if omitted) and maximum is 50 templates per request. Example: 50
namestring- Return only templates whose name contains this text, ignoring case. Example: Scalekit test
offsetinteger- The pagination or "starting point" of the templates to be returned. Setting it to 0 with a limit of 50 will retrieve the first 50 templates. Increasing the offset by 50 will return the next set of templates, and so on. Example: 0
onesignal_user_getRetrieve a user including aliases, properties, and subscriptions.Read-onlyView user
Retrieve a user including aliases, properties, and subscriptions. Returns an object with properties, identity, subscriptions.
Inputs
alias_idstringrequired- The specific identifier for the given alias to identify the user. Example: user-123
alias_labelstringrequired- The alias name or key to locate the user. Most commonly set as `external_id` but can be the `onesignal_id` or a custom alias. Example: external_id
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
onesignal_user_identity_getRetrieve all aliases associated with a user using a known alias, such as an `external_id`, `onesignal_id`, or a custom alias.Read-onlyView user identity
Retrieve all aliases associated with a user using a known alias, such as an `external_id`, `onesignal_id`, or a custom alias. Returns an object with identity.
Inputs
alias_idstringrequired- The specific identifier for the given alias to identify the user. Example: user-123
alias_labelstringrequired- The alias name or key to locate the user. Most commonly set as `external_id` but can be the `onesignal_id` or a custom alias. Example: external_id
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
onesignal_custom_events_createCreate Custom Events.WriteCreate Custom Events
Create Custom Events. The Custom Events API allows you to record user events. Returns an object with errors.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
eventsarrayrequired- Array of event objects to be recorded. Maximum size for each event is `2024` bytes. Maximum size of request is `1` MB. Example: [{"name": "Scalekit test"}]
onesignal_email_sendSend an email message now or at a scheduled time to OneSignal users, email subscriptions, segments or filters.WriteSend Email
Send an email message now or at a scheduled time to OneSignal users, email subscriptions, segments or filters. Returns the message id and any invalid recipients (errors). Use this for email. Use onesignal_push_send for push and onesignal_sms_send for SMS. Target with include_aliases (for example external_id), include_subscription_ids, or included_segments/excluded_segments, or filters; set app_id to your App ID.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
email_bodystringrequired- The body of the email in HTML format. Required if `template_id` is not set. Supports Message Personalization. Example: jane@example.com
email_subjectstringrequired- The subject of the email. Supports Message Personalization. Example: This is your email subject.
custom_dataobject- Include user or context-specific data (e.g., cart items, OTPs, links) in a message. Use with `template_id`. See Message Personalization. Max size: 2KB (Push/SMS), 10KB (Email). Example: {"first_name": "Jane", "order_id": "A-1001"}
delayed_optionstring- Controls how messages are delivered on a per-user basis. `timezone` sends at the same local time across time zones. `last-active` delivers based on each user's most recent session. Not compatible with Push Throttling. If you set `delayed_option`, set `throttle_rate_per_minute` to `0`. Example: timezone
delivery_time_of_daystring- Use with `delayed_option: 'timezone'` to set a consistent local delivery time. Accepted formats: `'9:00AM'` (12-hour), `'21:45'` (24-hour), `'09:45:30'` (HH:mm:ss). Example: 9:00AM
disable_email_click_trackingboolean- If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. See Email unsubscribe links & headers. Defaults to `false`. Example: false
email_bccarray- BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. For every email sent, an additional billable email is sent to each BCC address. See BCC Emails. Example: ["jane@example.com"]
email_from_addressstring- The full email address shown in the 'From' field of the email (e.g., `promotions@news.example.com`). This is what recipients see as the sender. If not specified, OneSignal uses the default 'Sender Email' set in your Dashboard's Email Settings. See Senders. Example: jane@example.com
email_from_namestring- The name the email is sent from. Defaults to the 'Sender Name' in the Email Settings of your OneSignal Dashboard. See Email setup and Senders. Example: Your Company
email_preheaderstring- Preview text displayed after the email subject. Example: jane@example.com
email_reply_to_addressstring- The email address users reply to. Defaults to the 'Reply-To' address in the Email Settings of your OneSignal Dashboard. See Email setup. Example: jane@example.com
email_sender_domainstring- The authenticated sending domain used for email delivery. This domain must be verified in your DNS records and will determine which domain handles the mail transfer. It may not always exactly match the domain in the `email_from_address` (e.g., `email_from_address = news@example.com` while `email_sender_domain = mail.example.com`), but the root domain must align for DMARC compliance. If not specified, OneSignal uses the default sender email's domain configured in your Dashboard. See Email setup and Senders. Example: jane@example.com
email_toarray- Send email to specific users by their email address. Include up to 20,000 email addresses per API call. If the email address does not exist within the OneSignal App, then a new email Subscription will be created. Can only be used when sending Email. Not compatible with any other targeting parameters like `filters`, `include_aliases`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: ["jane@example.com"]
email_warm_upobject- Required when `kind` is `warmup`. The gradual sending schedule for the campaign. See Auto Warm Up. Example: {"strategy": "recommended"}
excluded_segmentsarray- Exclude users in predefined Segments. Overrides membership in any segment specified in the `included_segments`. Not compatible with any other targeting parameters like `filters`, `include_aliases`, or `include_subscription_ids`. See Sending messages with the OneSignal API. Example: ["Engaged Users"]
filtersarray- Filters define the segment based on user properties like tags, activity, or location using flexible AND/OR logic. Limited to 200 total entries, including fields and `OR` operators. See Sending messages with the OneSignal API. Example: [{"field": "tag", "key": "level", "relation": ">", "value": "10"}]
idempotency_keystring- A unique identifier used to prevent duplicate messages from repeat API calls. See Idempotent notification requests. Any RFC 9562 UUID supported. Valid for 30 days. Previously called `external_id`. Example: welcome-email
include_aliasesobject- Target up to 20,000 users by their `external_id`, `onesignal_id`, or your own custom alias. Use with `target_channel` to control the delivery channel. Not compatible with any other targeting parameters like `filters`, `include_subscription_ids`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: {"external_id": ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]}
include_subscription_idsarray- Target users' specific subscriptions by ID. Include up to 20,000 `subscription_id` per API call. Not compatible with any other targeting parameters like `filters`, `include_aliases`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]
include_unsubscribedboolean- Used for important account-related, non-marking emails. If set to `true` it will send the email to unsubscribed email addresses. Defaults to `false`. See Email unsubscribe links & headers. Example: false
included_segmentsarray- Target predefined Segments. Users that are in multiple segments will only be sent the message once. Can be combined with `excluded_segments`. Not compatible with any other targeting parameters like `filters`, `include_aliases`, or `include_subscription_ids`. See Sending messages with the OneSignal API. Example: ["Active Users"]
kindstring- Set to `warmup` to send this as an Auto Warm Up campaign: a single campaign delivered gradually to your audience over several days, so you don't have to pace sends manually. OneSignal generates a sending schedule based on your past delivery volumes, scheduled Auto Warm Up emails, and the size of your current audience. Requires `email_warm_up`. Not compatible with `send_after`. The campaign will be scheduled to begin at its first stage's `start` time. Example: warmupone of
warmup namestring- An internal name you set to help organize and track messages. Not shown to recipients. Maximum 128 characters. Example: Scalekit test
send_afterstring- Schedule delivery for a future date/time (in UTC). The format must be valid per the ISO 8601 standard and compatible with `JavaScript's Date() parser`. Example: `2025-09-24T14:00:00-07:00`. Not compatible with `kind: "warmup"`.
target_channelstring- The targeted delivery channel. Required when using `include_aliases`. Accepts `push`, `email`, or `sms`. Example: emailone of
pushemailsms template_idstring- The template ID in UUID v4 format set for the message if applicable. See Templates. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
onesignal_journey_createCreate a new journey.WriteCreate journey
Create a new journey. Journeys are always created in the `draft` state; sending a server-controlled field such as `state` or `id` returns a `400` validation error. Returns an object with id, app_id, name, description, state, created_at, updated_at, started_at, archived_at, created_source, audience, early_exit and more.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
namestringrequired- Journey name. Example: Welcome series
audienceobject- The journey entry audience. Either a segment-based or event-triggered audience. Example: {"kind": "segment", "included_segment_ids": ["3f7c1e90-0000-0000-0000-000000000001"], "excluded_segment_ids": []}
descriptionstring- Optional journey description. Example: Onboard new users over their first week.
early_exitobject- Conditions that remove a user from the journey before it completes. At least one rule must be set under `rules`; an early_exit that configures no rule is rejected. Send `null` to remove early exit entirely, or `null` for an individual rule to drop just that rule. Example: {"rules": {"on_segment": {"included_segment_ids": ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]}, "when_not_in_audience": false}, "tag_on_early_exit": {"plan": "pro"}}
nodesarray- Ordered list of journey nodes. Server-assigned `id` fields are rejected on create with a `400` validation error. Example: [{"kind": "send_push", "template_id": "9a8b7c6d-0000-0000-0000-000000000001"}, {"kind": "wait", "duration_seconds": 86400}, {"kind": "send_email", "template_id": "9a8b7c6d-0000-0000-0000-000000000002"}]
reentry_rulesobject- Controls whether and how soon a user can re-enter the journey. `null` means re-entry is not allowed. Example: {"duration_seconds": 600}
scheduleobject- Optional future start and/or stop time. `null` means no scheduled activation. Example: {"start_at": "2026-01-15T09:30:00Z", "stop_at": "2026-01-15T09:30:00Z"}
onesignal_journey_duplicateCopy an existing journey.WriteDuplicate journey
Copy an existing journey. The copy is always in the `draft` state, whatever state the source is in, and the source does not change. Returns an object with id, app_id, name, description, state, created_at, updated_at, started_at, archived_at, created_source, audience, early_exit and more. Needs id from onesignal_journeys_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
idstringrequired- UUID of the journey to copy. Example: YOUR_JOURNEY_ID
overridesobject- Journey fields to apply to the copy. Accepts the same writable fields as Create journey, and none of them are required. Fields sent outside `overrides` are ignored. Example: {"name": "Welcome series v2"}
onesignal_journey_node_updateApply a partial update to a single node, located by its server-assigned `id`, using JSON Merge Patch (RFC 7396).WriteUpdate journey node
Apply a partial update to a single node, located by its server-assigned `id`, using JSON Merge Patch (RFC 7396). Returns an object with id, app_id, name, description, state, created_at, updated_at, started_at, archived_at, created_source, audience, early_exit and more. Only the fields you pass change; omitted fields keep their current values. Needs id from onesignal_journeys_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
idstringrequired- UUID of the journey that owns the node. Example: YOUR_JOURNEY_ID
nodeobjectrequired- The node fields to change, as a JSON Merge Patch merged onto the node: fields you pass replace the current values and `null` clears a field. The allowed fields depend on the node's kind; get them from onesignal_journey_schema_get with operation `update_node`. Do not change `kind` or `id`. Example: {"duration_seconds": 7200}
node_idstringrequired- Server-assigned UUID of the node to update, from a prior View journey fetch. Example: YOUR_NODE_ID
concurrency_keystring- Optional optimistic-concurrency token. Pass the `concurrency_key` from a prior fetch to reject the update with `409` if the journey changed in the meantime. Omit to skip the check. It is not merged onto the node. Example: welcome-email
onesignal_journey_updateApply a partial update to a journey using JSON Merge Patch (RFC 7396).WriteUpdate journey
Apply a partial update to a journey using JSON Merge Patch (RFC 7396). Returns an object with id, app_id, name, description, state, created_at, updated_at, started_at, archived_at, created_source, audience, early_exit and more. Only the fields you pass change; omitted fields keep their current values. Needs id from onesignal_journeys_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
idstringrequired- UUID of the journey to update. Example: YOUR_JOURNEY_ID
audienceobject- The journey entry audience. Either a segment-based or event-triggered audience. Example: {"kind": "segment"}
concurrency_keystring- Optional optimistic-concurrency token. Pass the `concurrency_key` from a prior fetch to reject the update with `409` if the journey changed in the meantime. Omit to skip the check. Example: welcome-email
descriptionstring- Journey description. Send `null` to clear it. Example: Updated onboarding copy.
early_exitobject- Conditions that remove a user from the journey before it completes. At least one rule must be set under `rules`; an early_exit that configures no rule is rejected. Send `null` to remove early exit entirely, or `null` for an individual rule to drop just that rule. Example: {"rules": {"on_segment": {"included_segment_ids": ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]}, "when_not_in_audience": false}, "tag_on_early_exit": {"plan": "pro"}}
namestring- Journey name. Example: Welcome series v2
nodesarray- Full ordered list of nodes, which replaces the existing graph wholesale. Preserve each node's server-assigned `id` from a prior fetch to keep in-flight users on that node; omit `id` to add a new node. Example: [{"kind": "wait"}]
reentry_rulesobject- Controls whether and how soon a user can re-enter the journey. `null` means re-entry is not allowed. Example: {"duration_seconds": 600}
scheduleobject- Optional future start and/or stop time. `null` means no scheduled activation. Example: {"start_at": "2026-01-15T09:30:00Z", "stop_at": "2026-01-15T09:30:00Z"}
statestring- Target state. Set `active` to activate a `draft` journey, or `scheduled` together with a future `schedule.start_at` to activate it later. Set `archived` to stop a running journey; archiving is permanent, and later writes return `422 journey-archived`. Only `scheduled` and `processing` journeys can return to `draft`. Example: draftone of
draftscheduledactivearchived
onesignal_live_activity_startRemotely start a Live Activity on iOS devices via OneSignal's REST API.WriteStart Live Activity
Remotely start a Live Activity on iOS devices via OneSignal's REST API. Returns an object with notification_id.
Inputs
activity_idstringrequired- The topic key for this Live Activity. Every device that starts an activity with this value receives the same updates, so one Update Live Activity request fans out to all of them. Use one shared value when many users follow the same event, such as `game-1234` for a live match. Use a distinct value per user when the content is specific to that user, such as `order-98765` for one delivery. Never reuse a per-user value across users, or one user's content appears on every other user's device. Save the value, because updating or ending the activity requires it. See Choose an activity ID. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
activity_typestringrequired- The name of the Live Activity defined in your app. This should match the `your-nameAttributes` struct used in your app code. See Live Activities developer setup. Example: If your app defines a Live Activity as `OneSignalWidgetAttributes`, then `activity_type` should be `OneSignalWidgetAttributes`.
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
contentsobjectrequired- The push message body with language-specific values. Example: {"en": "Your order A-1001 is on its way."}
eventstringrequired- The action to perform on the Live Activity. This request only supports `start`. Example: startone of
start event_attributesobjectrequired- The static data to initialize the Live Activity. See Live Activities developer setup. Example: {"order_id": "A-1001"}
event_updatesobjectrequired- The content used to update a running Live Activity. The object must conform to the `ContentState` interface defined within your app's Live Activity. See Live Activities developer setup. Example: {"status": "out_for_delivery", "eta_minutes": 15}
headingsobjectrequired- The push title with language-specific values. Example: {"en": "Your order shipped"}
namestringrequired- An internal name you set to help organize and track messages. Not shown to recipients. Maximum 128 characters. Example: Scalekit test
excluded_segmentsarray- Exclude users in predefined Segments. Overrides membership in any segment specified in the `included_segments`. Not compatible with any other targeting parameters like `filters`, `include_aliases`, or `include_subscription_ids`. See Sending messages with the OneSignal API. Example: ["Engaged Users"]
filtersarray- Dynamically target users based on properties like tags, activity, or location using flexible AND/OR logic. Limited to 200 total entries, including fields and `OR` operators. Not compatible with other targeting parameters like `include_aliases`, `include_subscription_ids`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: [{"field": "tag", "key": "level", "relation": ">", "value": "10"}]
idempotency_keystring- A unique identifier used to prevent duplicate messages from repeat API calls. See Idempotent notification requests. Any RFC 9562 UUID supported. Valid for 30 days. Previously called `external_id`. Example: welcome-email
include_aliasesobject- Target up to 20,000 users by their `external_id`, `onesignal_id`, or your own custom alias. Use with `target_channel` to control the delivery channel. Not compatible with any other targeting parameters like `filters`, `include_subscription_ids`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: {"external_id": ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]}
include_subscription_idsarray- Target users' specific subscriptions by ID. Include up to 20,000 `subscription_id` per API call. Not compatible with any other targeting parameters like `filters`, `include_aliases`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]
included_segmentsarray- Target predefined Segments. Users that are in multiple segments will only be sent the message once. Can be combined with `excluded_segments`. Not compatible with any other targeting parameters like `filters`, `include_aliases`, or `include_subscription_ids`. See Sending messages with the OneSignal API. Example: ["Active Users"]
ios_relevance_scorenumber- A value between `0` and `1`. If you start more than one Live Activity for your app, the Live Activity with the highest relevance score appears in the Dynamic Island. If Live Activities have the same relevance score, the system displays the Live Activity that started first. Additionally, the Relevance Score determines the order of your Live Activities on the Lock Screen. Example: 0.5
ios_soundstring- The name of a sound file in your app bundle, including its extension (for example, `explode_sound.wav`), to play when this message is delivered. Omit this field to deliver it silently. See Notification sounds.
priorityinteger- Set the urgency of this start request. `10` delivers immediately and counts against the budget Apple imposes per device for high-priority Live Activity updates. `5` delivers opportunistically and does not count against the budget. When you omit this parameter, OneSignal sends `10`. Apple recommends you try `5` first and reserve `10` for updates that need the user's immediate attention. If your app needs frequent high-priority updates, add the `NSSupportsLiveActivitiesFrequentUpdates` key to your `Info.plist`. See Update frequency and throttling. Example: 10one of
510 stale_dateinteger- A Unix timestamp (in seconds) that indicates the date the Live Activity is considered outdated. Once this time is reached, the system updates the Live Activity to `ActivityState.stale` at which point you can update the Live Activity to indicate that its content is out of date. Example: 1767225600
onesignal_live_activity_updateUpdate or terminate running iOS Live Activities using OneSignal's Live Activities API.WriteUpdate Live Activity
Update or terminate running iOS Live Activities using OneSignal's Live Activities API. Returns an object with id.
Inputs
activity_idstringrequired- The topic key of the Live Activity to update, set when the activity started. This request fans out to every device registered under this value. See Choose an activity ID. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
eventstringrequired- The action to perform on the Live Activity. `update` updates the content of an existing Live Activity without ending it. `end` ends the Live Activity and removes it from the user's view. See Apple's developer docs on Starting and updating Live Activities. Example: updateone of
updateend event_updatesobjectrequired- The content used to update a running Live Activity. The object must conform to the `ContentState` interface defined within your app's Live Activity. See Live Activities developer setup. Example: {"status": "out_for_delivery", "eta_minutes": 15}
namestringrequired- An internal name you set to help organize and track messages. Not shown to recipients. Maximum 128 characters. Example: Scalekit test
contentsobject- The push message body with language-specific values. Example: {"en": "Your order A-1001 is on its way."}
dismissal_dateinteger- A Unix timestamp (in seconds) indicating when the Live Activity should be removed from the user's device. Use with the `end` event. If not set, the Live Activity is dismissed automatically after 4 hours. To dismiss immediately, the user must have already allowed the Live Activity, then set a timestamp in the past (for example `1663177260`). Alternatively, provide a date within a four-hour window to dismiss before the default 4-hour period. See Apple's documentation for more. Example: 1767225600
ios_relevance_scorenumber- A value between `0` and `1`. If you start more than one Live Activity for your app, the Live Activity with the highest relevance score appears in the Dynamic Island. If Live Activities have the same relevance score, the system displays the Live Activity that started first. Additionally, the Relevance Score determines the order of your Live Activities on the Lock Screen. Example: 0.5
ios_soundstring- The name of a sound file in your app bundle, including its extension (for example, `explode_sound.wav`), to play when this message is delivered. Omit this field to deliver it silently. See Notification sounds.
priorityinteger- Set the urgency of this update. `10` delivers immediately and counts against the budget Apple imposes per device for high-priority Live Activity updates. `5` delivers opportunistically and does not count against the budget. When you omit this parameter, OneSignal sends `10`. Apple recommends you try `5` first and reserve `10` for updates that need the user's immediate attention. If your app needs frequent high-priority updates, add the `NSSupportsLiveActivitiesFrequentUpdates` key to your `Info.plist`. See Update frequency and throttling. Example: 10one of
510 stale_dateinteger- A Unix timestamp (in seconds) that indicates the date the Live Activity is considered outdated. Once this time is reached, the system updates the Live Activity to `ActivityState.stale` at which point you can update the Live Activity to indicate that its content is out of date. Example: 1767225600
onesignal_push_sendSend a push notification now or at a scheduled time to OneSignal users, subscriptions, segments or filters.WriteSend Push Notification
Send a push notification now or at a scheduled time to OneSignal users, subscriptions, segments or filters. Returns the message id and, for an immediate send, any invalid recipients (errors). Use this for push. Use onesignal_email_send for email and onesignal_sms_send for SMS. Use onesignal_message_recipients_estimate first to size the audience without sending. Target with include_aliases (for example external_id), include_subscription_ids, or included_segments/excluded_segments, or filters; set app_id to your App ID.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
contentsobjectrequired- The main message body with language-specific values. Supports Message Personalization. Example: {"en": "Your order A-1001 is on its way."}
android_channel_idstring- The UUID of the Android notification channel category created within your OneSignal app. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
android_groupstring- An ID to group notifications on Google Android devices. Notifications with the same identifier are organized together in the notification center. Example: orders
app_urlstring- Similar to the `url` parameter but exclusively targets mobile platforms like iOS, Android. Accepts values other than `https` but must use `your-app-scheme://` protocol. Example: https://example.com/hook
big_picturestring- The local name or URL of the image to include in your Google Android notification. Users can expand the notification to view the images. See Images & Rich Media. Example: https://example.com/images/banner.png
buttonsarray- Add a maximum of 3 Action Buttons to Android and iOS push notifications. See Action Buttons. Example: [{"id": "b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b", "text": "Hello from Scalekit"}]
chrome_web_iconstring- The URL of the icon to display in the Chrome web notification. Defaults to the resource set in the OneSignal dashboard. See Notification icons. Example: https://example.com/images/icon-256.png
chrome_web_imagestring- The URL of the image to include in your Chrome notification. Users can expand the notification to view the images. Supported on Chrome for Windows and Android. macOS does not support this parameter and instead expands the `chrome_web_icon`. See Images & Rich Media. Example: https://example.com/images/banner.png
collapse_idstring- An ID that replaces older notifications with newer ones that have the same identifier. For mobile push only. See Push: Collapse ID. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
content_availableboolean- Allows for sending data/background notifications to the Android and iOS apps. Set to `true` and omit `contents`. Apple interprets this as `content-available=1`. See Data & background notifications. Example: false
custom_dataobject- Include user or context-specific data (e.g., cart items, OTPs, links) in a message. Use with `template_id`. See Message Personalization. Max size: 2KB (Push/SMS), 10KB (Email). Example: {"first_name": "Jane", "order_id": "A-1001"}
dataobject- Bundle a custom data map within your notification, which is then passed to your app. See Push: Additional Data. Example: {"deep_link": "myapp://orders/A-1001"}
delayed_optionstring- Controls how messages are delivered on a per-user basis. `timezone` sends at the same local time across time zones. `last-active` delivers based on each user's most recent session. Not compatible with Push Throttling. If you set `delayed_option`, set `throttle_rate_per_minute` to `0`. Example: timezone
delivery_time_of_daystring- Use with `delayed_option: 'timezone'` to set a consistent local delivery time. Accepted formats: `'9:00AM'` (12-hour), `'21:45'` (24-hour), `'09:45:30'` (HH:mm:ss). Example: 9:00AM
enable_frequency_capboolean- Overrides the frequency cap set in the OneSignal dashboard settings. Must be enabled through the dashboard first. Only available with push notifications. See Frequency Capping. Set to `false` to disable frequency capping. Example: false
excluded_segmentsarray- Exclude users in predefined Segments. Overrides membership in any segment specified in the `included_segments`. Not compatible with any other targeting parameters like `filters`, `include_aliases`, or `include_subscription_ids`. See Sending messages with the OneSignal API. Example: ["Engaged Users"]
filtersarray- Filters define the segment based on user properties like tags, activity, or location using flexible AND/OR logic. Limited to 200 total entries, including fields and `OR` operators. See Sending messages with the OneSignal API. Example: [{"field": "tag", "key": "level", "relation": ">", "value": "10"}]
headingsobject- The message title with language-specific values. Required for Huawei and Web Push. If not set for Web Push, it defaults to your 'Site Name'. Not required if using `template_id` or `content_available`. Supports Message Personalization and must include the same languages as `contents` to ensure localization consistency. Example: {"en": "Your order shipped"}
idempotency_keystring- A unique identifier used to prevent duplicate messages from repeat API calls. See Idempotent notification requests. Any RFC 9562 UUID supported. Valid for 30 days. Previously called `external_id`. Example: welcome-email
include_aliasesobject- Target up to 20,000 users by their `external_id`, `onesignal_id`, or your own custom alias. Use with `target_channel` to control the delivery channel. Not compatible with any other targeting parameters like `filters`, `include_subscription_ids`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: {"external_id": ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]}
include_subscription_idsarray- Target users' specific subscriptions by ID. Include up to 20,000 `subscription_id` per API call. Not compatible with any other targeting parameters like `filters`, `include_aliases`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]
included_segmentsarray- Target predefined Segments. Users that are in multiple segments will only be sent the message once. Can be combined with `excluded_segments`. Not compatible with any other targeting parameters like `filters`, `include_aliases`, or `include_subscription_ids`. See Sending messages with the OneSignal API. Example: ["Active Users"]
ios_attachmentsobject- The local name or URL of the media attachment to include in your notification. Users can expand the notification to view images, videos, or other supported attachments. See Images & Rich Media. Example: {"id": "b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"}
ios_badgeCountinteger- Use with `ios_badgeType` to determine the numerical change to your app's badge count. See Badges. Example: 1
ios_badgeTypestring- Set or increment the badge count on iOS devices. Use with `ios_badgeCount`. See Badges. Example: Noneone of
NoneSetToIncrease ios_interruption_levelstring- The priority and delivery timing of iOS notifications based on their importance and the urgency with which they should interrupt the user. See iOS Focus modes and interruption levels. Example: activeone of
activepassivetime_sensitivecritical ios_soundstring- The name of a sound file in your app bundle, including its extension (for example, `explode_sound.wav`), to play when this message is delivered. Omit this field to deliver it silently. See Notification sounds.
large_iconstring- The local name or URL of the large icon to display in the Google Android notification. See Notification icons. Example: https://example.com/images/icon-256.png
namestring- An internal name you set to help organize and track messages. Not shown to recipients. Maximum 128 characters. Example: Scalekit test
priorityinteger- Set the priority based on the urgency of the message. `10` - High priority. `5` - Normal priority. Recommended and default value is `10`. APNs and FCM use this parameter to determine how quickly a notification is delivered and processed, particularly in power-saving modes. If sending data/background notifications, `5` (Normal priority) is recommended. For details, see APNs `apns-priority` and FCM `priority`. Example: 10one of
105 send_afterstring- Schedule delivery for a future date/time (in UTC). The format must be valid per the ISO 8601 standard and compatible with `JavaScript's Date() parser`. Example: `2025-09-24T14:00:00-07:00`
small_iconstring- The local name of the small icon to display in the Google Android notification. See Notification icons. Example: ic_stat_onesignal_default
subtitleobject- iOS only. The subtitle with language-specific values. Supports Message Personalization and must include the same languages as `contents` to ensure localization consistency. Example: {"en": "Arriving Thursday"}
target_channelstring- The targeted delivery channel. Required when using `include_aliases`. Accepts `push`, `email`, or `sms`. Example: pushone of
pushemailsms template_idstring- The template ID in UUID v4 format set for the message if applicable. See Templates. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
thread_idstring- An ID to group notifications on Apple devices. Notifications with the same identifier are organized together in the notification center. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
throttle_rate_per_minutenumber- Overrides the throttle limit set in the OneSignal dashboard settings. Must be enabled through the dashboard. Only available with push notifications. See Push Throttling. If `throttle_rate_per_minute` is set to `0`, then the message will be sent immediately without any rate limiting. Example: 1000
ttlinteger- The duration in seconds for which a notification remains valid if the device is offline. Any number between `0` and `2419200` (28 days). Defaults to 3 days. See Push: Time to Live. Example: 259200
urlstring- The `https`URL that opens in the browser when a user interacts with the notification. See URLs, Links and Deep Links. Supports Message Personalization. Example: https://example.com/hook
web_buttonsarray- Add a maximum of 2 Action Buttons to Chrome web push notifications. See Action Buttons. Example: [{"id": "b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b", "text": "Hello from Scalekit", "url": "https://example.com/hook"}]
web_urlstring- Use with `app_url` if your app and website need different URLs. Accepts URLs with protocol `https://`. Example: https://example.com/hook
onesignal_segment_createProgrammatically create segments in your OneSignal app using flexible filters and targeting rules.WriteCreate segment
Programmatically create segments in your OneSignal app using flexible filters and targeting rules. Returns an object with success, id.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
filtersarrayrequired- Filters define the segment based on user properties like tags, activity, or location using flexible AND/OR logic. Limited to 200 total entries, including fields and `OR` operators. See Sending messages with the OneSignal API. Example: [{"field": "tag", "key": "level", "relation": ">", "value": "10"}]
namestringrequired- An internal name you set to help organize and track Segments. Maximum 128 characters. Example: YOUR_SEGMENT_NAME
descriptionstring- Optional human-readable description for the segment. Maximum 255 characters. Example: YOUR_SEGMENT_DESCRIPTION
idstring- UUID of the segment. If left empty, it will be assigned automatically. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
onesignal_segment_updateUpdate an existing segment's name and/or filters.WriteUpdate segment
Update an existing segment's name and/or filters. The name parameter is always required. Returns an object with success, id. Only the fields you pass change; omitted fields keep their current values. Needs segment_id from onesignal_segments_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
namestringrequired- Required. The segment name. Maximum 128 characters. Example: YOUR_SEGMENT_NAME
segment_idstringrequired- The segment's unique identifier. In the dashboard, go to Audience > Segments, open the segment's options menu, and select Copy segment ID. You can also get it from the View segments API or the segment's URL in the dashboard. Example: YOUR_SEGMENT_ID
descriptionstring- Optional human-readable description for the segment. Maximum 255 characters. Pass an empty string to clear; omit to leave unchanged. Example: YOUR_SEGMENT_DESCRIPTION
filtersarray- Optional. When provided, replaces all existing filters. Filters define the segment based on user properties like tags, activity, or location using flexible AND/OR logic. Limited to 200 total entries, including fields and `OR` operators. See Create segment for filter syntax. Example: [{"field": "tag", "key": "level", "relation": ">", "value": "10"}]
onesignal_sms_sendSend an SMS or MMS message now or at a scheduled time to OneSignal users, SMS subscriptions, phone numbers, segments or filters.WriteSend SMS
Send an SMS or MMS message now or at a scheduled time to OneSignal users, SMS subscriptions, phone numbers, segments or filters. Returns the message id and any invalid recipients (errors). Use this for SMS. Use onesignal_push_send for push and onesignal_email_send for email. Target with include_aliases (for example external_id), include_subscription_ids, or included_segments/excluded_segments, or filters; set app_id to your App ID.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
contentsobjectrequired- The main message body with language-specific values. Too many characters may result in multiple messages and increased costs. See SMS. Required unless using `template_id`. Supports Message Personalization. You can add trackable links to your SMS via the API by including liquid syntax in your message contents. For example: {{'your_url' | track_link}} The liquid syntax block will be replaced with a trackable short link in the following format: 1sgnl.co/XXXX. Using trackable links allows you to see the click through rates of your SMS. Example: {"en": "Your order A-1001 is on its way."}
target_channelstringrequired- The targeted delivery channel. Required when using `include_aliases` and `included_segments` for SMS/RCS. Accepts `push`, `email`, or `sms`. Example: smsone of
pushemailsms custom_dataobject- Include user or context-specific data (e.g., cart items, OTPs, links) in a message. Use with `template_id`. See Message Personalization. Max size: 2KB (Push/SMS), 10KB (Email). Example: {"first_name": "Jane", "order_id": "A-1001"}
excluded_segmentsarray- Exclude users in predefined Segments. Overrides membership in any segment specified in the `included_segments`. Not compatible with any other targeting parameters like `filters`, `include_aliases`, or `include_subscription_ids`. See Sending messages with the OneSignal API. Example: ["Engaged Users"]
filtersarray- Filters define the segment based on user properties like tags, activity, or location using flexible AND/OR logic. Limited to 200 total entries, including fields and `OR` operators. See Sending messages with the OneSignal API. Example: [{"field": "tag", "key": "level", "relation": ">", "value": "10"}]
idempotency_keystring- A unique identifier used to prevent duplicate messages from repeat API calls. See Idempotent notification requests. Any RFC 9562 UUID supported. Valid for 30 days. Previously called `external_id`. Example: welcome-email
include_aliasesobject- Target up to 20,000 users by their `external_id`, `onesignal_id`, or your own custom alias. Use with `target_channel` to control the delivery channel. Not compatible with any other targeting parameters like `filters`, `include_subscription_ids`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: {"external_id": ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]}
include_phone_numbersarray- Send SMS/MMS to specific users by their phone number in E.164 format. Can only be used when sending SMS/MMS. Include up to 20,000 phone numbers per API call. If the phone number does not exist within the OneSignal App, then a new SMS Subscription will be created. Not compatible with any other targeting parameters like `filters`, `include_aliases`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: ["+14155550123"]
include_subscription_idsarray- Target users' specific subscriptions by ID. Include up to 20,000 `subscription_id` per API call. Not compatible with any other targeting parameters like `filters`, `include_aliases`, `included_segments`, or `excluded_segments`. See Sending messages with the OneSignal API. Example: ["b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"]
included_segmentsarray- Target predefined Segments. Users that are in multiple segments will only be sent the message once. Can be combined with `excluded_segments`. Requires `target_channel` to be set to `'sms'` or `isSms=true` when sending SMS/RCS. Not compatible with any other targeting parameters like `filters`, `include_aliases`, or `include_subscription_ids`. See Sending messages with the OneSignal API. Example: ["Active Users"]
namestring- An internal name you set to help organize and track messages. Not shown to recipients. Maximum 128 characters. Example: Scalekit test
send_afterstring- Schedule delivery for a future date/time (in UTC). The format must be valid per the ISO 8601 standard and compatible with `JavaScript's Date() parser`. Example: `2025-09-24T14:00:00-07:00`
sms_fromstring- The Messaging Service ID or phone number used to send the SMS or MMS. Its recommended to use Messaging Service SIDs (e.g., `MGxxxxxxxxxxxxxxx`) but also accepts E.164 phone numbers (e.g., `+12065551234`). Defaults to the sender selected in SMS Setup. If using per-sender opt-out, you must use a Messaging Service ID. Example: +14155550123
sms_media_urlsarray- URLs for the media files to be sent as MMS. Additional rates apply. `sms_from` must support sending MMS messages. See SMS. Example: ["https://example.com/hook"]
template_idstring- The template ID in UUID v4 format set for the message if applicable. See Templates. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
onesignal_subscription_alias_upsertCreate or update an alias for a user using a known subscription ID.WriteCreate or Update Alias by Subscription
Create or update an alias for a user using a known subscription ID. Returns an object with identity. Only the fields you pass change; omitted fields keep their current values.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
subscription_idstringrequired- The unique Subscription ID in UUID v4 format generated by OneSignal. See Subscriptions. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
identityobject- One or more aliases to be created for this user. Example: {"external_id": "test_external_id", "onesignal_id": "b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"}
onesignal_subscription_createAttach a new subscription (email, SMS, or push) to an existing OneSignal user identified by an alias.WriteCreate Subscription by alias
Attach a new subscription (email, SMS, or push) to an existing OneSignal user identified by an alias. Returns the JSON response from OneSignal.
Inputs
alias_idstringrequired- The specific identifier for the given alias to identify the user. Example: user-123
alias_labelstringrequired- The alias name or key to locate the user. Most commonly set as `external_id` but can be the `onesignal_id` or a custom alias. Example: external_id
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
subscriptionobjectrequired- The subscription's properties. Example: {"type": "Email", "token": "jane@example.com", "enabled": true}
onesignal_subscription_transferTransfer a Subscription to a different user within the same OneSignal app.WriteTransfer subscription
Transfer a Subscription to a different user within the same OneSignal app. Returns an object with identity. Only the fields you pass change; omitted fields keep their current values.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
subscription_idstringrequired- The unique Subscription ID in UUID v4 format to transfer to the new user. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
identityobject- Identifies the user that this subscription is moved to. Must contain exactly one alias. Example: {"external_id": "test_external_id", "onesignal_id": "b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"}
onesignal_subscription_updateUpdate properties on an existing OneSignal subscription using its subscription_id.WriteUpdate subscription
Update properties on an existing OneSignal subscription using its subscription_id. Returns the JSON response from OneSignal. Only the fields you pass change; omitted fields keep their current values.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
subscription_idstringrequired- The unique Subscription ID in UUID v4 format generated by OneSignal. See Subscriptions. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
subscriptionobject- The subscription's properties. Example: {"type": "Email", "token": "jane@example.com", "enabled": true}
onesignal_subscription_update_by_tokenUpdate properties on an existing Subscription using its token.WriteUpdate subscription By Token
Update properties on an existing Subscription using its token. Returns the JSON response from OneSignal. Only the fields you pass change; omitted fields keep their current values.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
tokenstringrequired- The push token, email address, or phone number associated with the subscription. Ensure the `token` is valid and correctly formatted for the chosen subscription `type`. Email format: Should be a valid email address that you confirmed can receive emails. SMS format: Phone number must be in E.164 format. iOSPush APNS token format: 64 characters, hexadecimal characters only (0-9,a-f). AndroidPush FCM token format: Typically 163 characters, alphanumeric characters, may contain hyphens, colons and underscore. Example: jane@example.com
token_typestringrequired- The subscription channel type. Must match the format of the token. Example: Emailone of
EmailSMSiOSPushAndroidPushHuaweiPushFireOSPushWindowsPushmacOSPushChromeExtensionPushChromePushFirefoxPushSafariPush subscriptionobject- The subscription's properties. Example: {"type": "Email", "token": "jane@example.com", "enabled": false}
onesignal_template_copy_to_appCreate a duplicate of a OneSignal message template in another app within the same organization.WriteCopy Template to Another App
Create a duplicate of a OneSignal message template in another app within the same organization. Returns an object with success. Needs template_id from onesignal_templates_list.
Inputs
target_app_idstringrequired- Specifies the OneSignal app ID that the template will be copied to. Cannot be the same as the `app_id`. Example: YOUR_OTHER_APP_ID
template_idstringrequired- The template ID in UUID v4 format. See Templates. Example: YOUR_TEMPLATE_ID
onesignal_template_createCreate reusable message templates for push, email, and SMS channels.WriteCreate template
Create reusable message templates for push, email, and SMS channels. Returns an object with id, name, channel, created_at, updated_at, content.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
namestringrequired- An internal name you set to help organize and track Templates. Maximum 128 characters. Example: YOUR_TEMPLATE_NAME
contentsobject- The main message body with language-specific values. Required for push and SMS templates. Supports Message Personalization. Example: {"en": "Your order A-1001 is on its way."}
dynamic_contentobject- Add personalization to your templates programmatically. No need to upload a CSV. See Dynamic Content for details. Example: {"campaign_id": {"A": {"title": "Custom Title A", "message": "Custom Message A", "url": "https://www.onesignal.com"}, "B": {"title": "Custom Title B", "message": "Custom Message B", "url": "https://www.onesignal.com/login"}}}
email_bodystring- The body of the email in HTML format. Required for email templates. Supports Message Personalization. Example: jane@example.com
email_subjectstring- Required for email templates. The subject of the email. Supports Message Personalization. Example: jane@example.com
isEmailboolean- Required to be set `true` for email templates. Example: false
isSMSboolean- Required to be set `true` for SMS templates. Example: false
onesignal_template_updateUpdate existing OneSignal message templates for push, email, or SMS.WriteUpdate template
Update existing OneSignal message templates for push, email, or SMS. Returns an object with id, name, channel, created_at, updated_at, content. Only the fields you pass change; omitted fields keep their current values. Needs template_id from onesignal_templates_list.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
namestringrequired- An internal name you set to help organize and track Templates. Maximum 128 characters. Example: YOUR_TEMPLATE_NAME
template_idstringrequired- The template ID in UUID v4 format. See Templates. Example: YOUR_TEMPLATE_ID
contentsobject- The main message body with language-specific values. Supports Message Personalization. Example: {"en": "Your order A-1001 is on its way."}
dynamic_contentobject- Add personalization to your templates programmatically. No need to upload a CSV. See Dynamic Content for details. Example: {"campaign_id": {"A": {"title": "Custom Title A", "message": "Custom Message A", "url": "https://www.onesignal.com"}, "B": {"title": "Custom Title B", "message": "Custom Message B", "url": "https://www.onesignal.com/login"}}}
email_bodystring- The body of the email in HTML format. Required for email templates. Supports Message Personalization. Example: jane@example.com
isEmailboolean- Required to be set `true` for email templates. Example: false
isSMSboolean- Required to be set `true` for SMS templates. Example: false
onesignal_user_alias_upsertCreate or update one or more user aliases when you already know an existing alias.WriteCreate or Update User Alias
Create or update one or more user aliases when you already know an existing alias. Returns an object with identity. Only the fields you pass change; omitted fields keep their current values.
Inputs
alias_idstringrequired- The specific identifier for the given alias to identify the user. Example: user-123
alias_labelstringrequired- The alias name or key to locate the user. Most commonly set as `external_id` but can be the `onesignal_id` or a custom alias. Example: external_id
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
identityobject- One or more aliases to be created for this user. Example: {"external_id": "test_external_id", "custom_alias_label": "the-users-custom-alias-id"}
onesignal_user_createCreate a new user or modify the subscriptions associated with an existing User.WriteCreate user
Create a new user or modify the subscriptions associated with an existing User. Returns an object with identity, properties.
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
identityobject- Defines identifiers for the user. The `external_id` must be used and should be unique across users. Example: {"external_id": "b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b"}
propertiesobject- Represents user profile data for a given user, including tags, preferences, user activity, and other valuable properties. Example: {"tags": {}, "language": "en"}
subscriptionsarray- The subscriptions object allows for creating or transferring subscriptions to a specified user. See Subscriptions. Example: [{"type": "Email", "token": "jane@example.com", "enabled": true}]
onesignal_user_updateModify a user's properties.WriteUpdate user
Modify a user's properties. Returns an object with properties. Only the fields you pass change; omitted fields keep their current values.
Inputs
alias_idstringrequired- The specific identifier for the given alias to identify the user. Example: user-123
alias_labelstringrequired- The alias name or key to locate the user. Most commonly set as `external_id` but can be the `onesignal_id` or a custom alias. Example: external_id
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
deltasobject- User properties that change frequently and generally only increment. Example: {"session_time": 10, "session_count": 10}
onesignal_subscription_idstring- Optional. Identifies a specific subscription to update. Some user properties, such as Session Time and Session Count, will update values on both the User and the Subscription. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
propertiesobject- Represents user profile data for a given user, including tags, preferences, user activity, and other valuable properties. Example: {"tags": {}, "language": "en"}
onesignal_journey_deletePermanently delete a journey by its UUID.DestructiveDelete journey
Permanently delete a journey by its UUID. Returns `{ "success": true }` on success. Returns an object with success. Needs id from onesignal_journeys_list.
- Idempotent
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
idstringrequired- UUID of the journey to delete. Example: YOUR_JOURNEY_ID
onesignal_message_cancelCancel a scheduled or currently sending OneSignal message so no further deliveries go out.DestructiveCancel Message
Cancel a scheduled or currently sending OneSignal message so no further deliveries go out. Returns success true when the message was stopped. Use onesignal_messages_list or onesignal_message_get to find the message id. Deliveries already made are not recalled.
- Idempotent
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
message_idstringrequired- The identifier of the message in UUID v4 format. Get this `id` in the response of your Create Message API request, the View Messages API, and in your OneSignal dashboard Message Reports. Example: Hello from Scalekit
onesignal_segment_deleteDelete segments from OneSignal.DestructiveDelete segment
Delete segments from OneSignal. Does not delete users or subscriptions. Returns an object with success. Needs segment_id from onesignal_segments_list.
- Idempotent
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
segment_idstringrequired- The segment's unique identifier. In the dashboard, go to Audience > Segments, open the segment's options menu, and select Copy segment ID. You can also get it from the View segments API or the segment's URL in the dashboard. Example: YOUR_SEGMENT_ID
onesignal_subscription_deleteDelete a specific subscription by its subscription_id.DestructiveDelete subscription
Delete a specific subscription by its subscription_id. Returns the JSON response from OneSignal.
- Idempotent
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
subscription_idstringrequired- The unique Subscription ID in UUID v4 format generated by OneSignal. See Subscriptions. Example: b5b4f9e3-6c2a-4b8e-9d1f-2a3c4e5f6a7b
onesignal_template_deletePermanently delete a specific message template from your OneSignal app using its template ID.DestructiveDelete template
Permanently delete a specific message template from your OneSignal app using its template ID. Returns an object with success. Needs template_id from onesignal_templates_list.
- Idempotent
Inputs
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
template_idstringrequired- The template ID in UUID v4 format. See Templates. Example: YOUR_TEMPLATE_ID
onesignal_user_alias_deleteRemove a specific alias from a user.DestructiveDelete alias
Remove a specific alias from a user. Returns an object with identity. Needs alias_label_to_delete from onesignal_user_identity_get.
- Idempotent
Inputs
alias_idstringrequired- The specific identifier for the given alias to identify the user. Example: user-123
alias_labelstringrequired- The alias name or key to locate the user. Most commonly set as `external_id` but can be the `onesignal_id` or a custom alias. Example: external_id
alias_label_to_deletestringrequired- The name of the alias to remove. Example: crm_id
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
onesignal_user_deleteDelete a user including all associated properties, subscriptions, and identity.DestructiveDelete user
Delete a user including all associated properties, subscriptions, and identity. Returns an object with identity.
- Idempotent
Inputs
alias_idstringrequired- The specific identifier for the given alias to identify the user. Example: user-123
alias_labelstringrequired- The alias name or key to locate the user. Most commonly set as `external_id` but can be the `onesignal_id` or a custom alias. Example: external_id
app_idstringrequired- The OneSignal App ID (a UUID) from Settings > Keys & IDs in the OneSignal dashboard.
No tools match.