KosmoKrator

productivity

OneSignal CLI for AI Agents

Use the OneSignal CLI from KosmoKrator to call OneSignal tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

OneSignal CLI Setup

OneSignal can be configured headlessly with `kosmokrator integrations:configure one-signal`.

Install, configure, and verify
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure one-signal --set api_key="$ONE_SIGNAL_API_KEY" --set app_id="$ONE_SIGNAL_APP_ID" --enable --read allow --write ask --json
kosmokrator integrations:doctor one-signal --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
api_key ONE_SIGNAL_API_KEY Secret secret yes API Key
app_id ONE_SIGNAL_APP_ID Text string yes App ID
url ONE_SIGNAL_URL URL url no API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call
kosmo integrations:call one-signal.onesignal_list_notifications '{"app_id":"example_app_id","limit":1,"offset":1}' --json
Provider shortcut
kosmo integrations:one-signal onesignal_list_notifications '{"app_id":"example_app_id","limit":1,"offset":1}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands
kosmo integrations:docs one-signal --json
kosmo integrations:docs one-signal.onesignal_list_notifications --json
kosmo integrations:schema one-signal.onesignal_list_notifications --json
kosmo integrations:search "OneSignal" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

one-signal.onesignal_list_notifications

List push notifications sent through OneSignal. Returns notification details including delivery stats, click counts, and outcomes. Use limit and offset for pagination.

Read read
Parameters
app_id, limit, offset
Generic call
kosmo integrations:call one-signal.onesignal_list_notifications '{"app_id":"example_app_id","limit":1,"offset":1}' --json
Shortcut
kosmo integrations:one-signal onesignal_list_notifications '{"app_id":"example_app_id","limit":1,"offset":1}' --json

one-signal.onesignal_get_notification

Get details of a specific OneSignal push notification by its ID. Returns full notification data including content, delivery stats, and targeting.

Read read
Parameters
id, app_id
Generic call
kosmo integrations:call one-signal.onesignal_get_notification '{"id":"example_id","app_id":"example_app_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_get_notification '{"id":"example_id","app_id":"example_app_id"}' --json

one-signal.onesignal_create_notification

Send a new push notification via OneSignal. Specify message contents (per language), optional headings, target segments, a click URL, and a custom data payload.

Write write
Parameters
app_id, payload, contents, headings, included_segments, url, data
Generic call
kosmo integrations:call one-signal.onesignal_create_notification '{"app_id":"example_app_id","payload":"example_payload","contents":"example_contents","headings":"example_headings","included_segments":"example_included_segments","url":"example_url","data":"example_data"}' --json
Shortcut
kosmo integrations:one-signal onesignal_create_notification '{"app_id":"example_app_id","payload":"example_payload","contents":"example_contents","headings":"example_headings","included_segments":"example_included_segments","url":"example_url","data":"example_data"}' --json

one-signal.onesignal_cancel_notification

Cancel a scheduled or currently outgoing OneSignal message by ID.

Write write
Parameters
message_id, app_id
Generic call
kosmo integrations:call one-signal.onesignal_cancel_notification '{"message_id":"example_message_id","app_id":"example_app_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_cancel_notification '{"message_id":"example_message_id","app_id":"example_app_id"}' --json

one-signal.onesignal_list_devices

List devices (players) registered in a OneSignal app. Returns device identifiers, platform, session counts, and tags. Use limit and offset for pagination.

Read read
Parameters
app_id, limit, offset
Generic call
kosmo integrations:call one-signal.onesignal_list_devices '{"app_id":"example_app_id","limit":1,"offset":1}' --json
Shortcut
kosmo integrations:one-signal onesignal_list_devices '{"app_id":"example_app_id","limit":1,"offset":1}' --json

one-signal.onesignal_get_device

Get details of a specific OneSignal device (player) by its ID. Returns push token, platform, session data, tags, and more.

Read read
Parameters
id, app_id
Generic call
kosmo integrations:call one-signal.onesignal_get_device '{"id":"example_id","app_id":"example_app_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_get_device '{"id":"example_id","app_id":"example_app_id"}' --json

one-signal.onesignal_list_apps

List all OneSignal apps accessible with the configured REST API key. Returns app names, IDs, player counts, and configuration.

Read read
Parameters
none
Generic call
kosmo integrations:call one-signal.onesignal_list_apps '{}' --json
Shortcut
kosmo integrations:one-signal onesignal_list_apps '{}' --json

one-signal.onesignal_get_current_app

Get details of a specific OneSignal app by its ID. Returns app configuration, player counts, and platform settings.

Read read
Parameters
app_id
Generic call
kosmo integrations:call one-signal.onesignal_get_current_app '{"app_id":"example_app_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_get_current_app '{"app_id":"example_app_id"}' --json

one-signal.onesignal_update_app

Update app configuration. This may require an organization-scoped API key.

Write write
Parameters
app_id, payload
Generic call
kosmo integrations:call one-signal.onesignal_update_app '{"app_id":"example_app_id","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_update_app '{"app_id":"example_app_id","payload":"example_payload"}' --json

one-signal.onesignal_create_user

Create a OneSignal user with optional identity aliases, properties, and subscriptions.

Write write
Parameters
app_id, payload
Generic call
kosmo integrations:call one-signal.onesignal_create_user '{"app_id":"example_app_id","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_create_user '{"app_id":"example_app_id","payload":"example_payload"}' --json

one-signal.onesignal_get_user

View a OneSignal user by alias, such as external_id or onesignal_id.

Read read
Parameters
app_id, alias_label, alias_id
Generic call
kosmo integrations:call one-signal.onesignal_get_user '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_get_user '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id"}' --json

one-signal.onesignal_update_user

Update user-level properties or deltas for a OneSignal user located by alias.

Write write
Parameters
app_id, alias_label, alias_id, payload
Generic call
kosmo integrations:call one-signal.onesignal_update_user '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_update_user '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id","payload":"example_payload"}' --json

one-signal.onesignal_delete_user

Delete a OneSignal user and all associated subscriptions by alias.

Write write
Parameters
app_id, alias_label, alias_id
Generic call
kosmo integrations:call one-signal.onesignal_delete_user '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_delete_user '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id"}' --json

one-signal.onesignal_get_user_identity

Fetch the identity aliases for a OneSignal user located by alias.

Read read
Parameters
app_id, alias_label, alias_id
Generic call
kosmo integrations:call one-signal.onesignal_get_user_identity '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_get_user_identity '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id"}' --json

one-signal.onesignal_create_or_update_alias

Create or update one or more identity aliases for a OneSignal user.

Write write
Parameters
app_id, alias_label, alias_id, identity
Generic call
kosmo integrations:call one-signal.onesignal_create_or_update_alias '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id","identity":"example_identity"}' --json
Shortcut
kosmo integrations:one-signal onesignal_create_or_update_alias '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id","identity":"example_identity"}' --json

one-signal.onesignal_delete_alias

Remove a specific alias from a OneSignal user without deleting the user.

Write write
Parameters
app_id, alias_label, alias_id, alias_label_to_delete
Generic call
kosmo integrations:call one-signal.onesignal_delete_alias '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id","alias_label_to_delete":"example_alias_label_to_delete"}' --json
Shortcut
kosmo integrations:one-signal onesignal_delete_alias '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id","alias_label_to_delete":"example_alias_label_to_delete"}' --json

one-signal.onesignal_get_identity_by_subscription

Fetch the user identity aliases associated with a subscription ID.

Read read
Parameters
app_id, subscription_id
Generic call
kosmo integrations:call one-signal.onesignal_get_identity_by_subscription '{"app_id":"example_app_id","subscription_id":"example_subscription_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_get_identity_by_subscription '{"app_id":"example_app_id","subscription_id":"example_subscription_id"}' --json

one-signal.onesignal_create_alias_by_subscription

Create or update aliases for the user associated with a known subscription ID.

Write write
Parameters
app_id, subscription_id, identity
Generic call
kosmo integrations:call one-signal.onesignal_create_alias_by_subscription '{"app_id":"example_app_id","subscription_id":"example_subscription_id","identity":"example_identity"}' --json
Shortcut
kosmo integrations:one-signal onesignal_create_alias_by_subscription '{"app_id":"example_app_id","subscription_id":"example_subscription_id","identity":"example_identity"}' --json

one-signal.onesignal_create_subscription

Create a subscription for a user identified by alias.

Write write
Parameters
app_id, alias_label, alias_id, payload
Generic call
kosmo integrations:call one-signal.onesignal_create_subscription '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_create_subscription '{"app_id":"example_app_id","alias_label":"example_alias_label","alias_id":"example_alias_id","payload":"example_payload"}' --json

one-signal.onesignal_update_subscription

Update a subscription by ID, such as tags, enabled state, or channel properties.

Write write
Parameters
app_id, subscription_id, payload
Generic call
kosmo integrations:call one-signal.onesignal_update_subscription '{"app_id":"example_app_id","subscription_id":"example_subscription_id","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_update_subscription '{"app_id":"example_app_id","subscription_id":"example_subscription_id","payload":"example_payload"}' --json

one-signal.onesignal_transfer_subscription

Transfer a subscription to another user identity within the same app.

Write write
Parameters
app_id, subscription_id, identity
Generic call
kosmo integrations:call one-signal.onesignal_transfer_subscription '{"app_id":"example_app_id","subscription_id":"example_subscription_id","identity":"example_identity"}' --json
Shortcut
kosmo integrations:one-signal onesignal_transfer_subscription '{"app_id":"example_app_id","subscription_id":"example_subscription_id","identity":"example_identity"}' --json

one-signal.onesignal_list_segments

List segments for an app with pagination.

Read read
Parameters
app_id, limit, offset
Generic call
kosmo integrations:call one-signal.onesignal_list_segments '{"app_id":"example_app_id","limit":1,"offset":1}' --json
Shortcut
kosmo integrations:one-signal onesignal_list_segments '{"app_id":"example_app_id","limit":1,"offset":1}' --json

one-signal.onesignal_get_segment

Get a segment by ID and optionally include segment filters.

Read read
Parameters
app_id, segment_id, include-segment-detail
Generic call
kosmo integrations:call one-signal.onesignal_get_segment '{"app_id":"example_app_id","segment_id":"example_segment_id","include-segment-detail":true}' --json
Shortcut
kosmo integrations:one-signal onesignal_get_segment '{"app_id":"example_app_id","segment_id":"example_segment_id","include-segment-detail":true}' --json

one-signal.onesignal_create_segment

Create a segment with name and filters.

Write write
Parameters
app_id, payload
Generic call
kosmo integrations:call one-signal.onesignal_create_segment '{"app_id":"example_app_id","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_create_segment '{"app_id":"example_app_id","payload":"example_payload"}' --json

one-signal.onesignal_update_segment

Update a segment name or filters.

Write write
Parameters
app_id, segment_id, payload
Generic call
kosmo integrations:call one-signal.onesignal_update_segment '{"app_id":"example_app_id","segment_id":"example_segment_id","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_update_segment '{"app_id":"example_app_id","segment_id":"example_segment_id","payload":"example_payload"}' --json

one-signal.onesignal_delete_segment

Delete a segment by ID.

Write write
Parameters
app_id, segment_id
Generic call
kosmo integrations:call one-signal.onesignal_delete_segment '{"app_id":"example_app_id","segment_id":"example_segment_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_delete_segment '{"app_id":"example_app_id","segment_id":"example_segment_id"}' --json

one-signal.onesignal_list_templates

List message templates for an app with pagination.

Read read
Parameters
app_id, limit, offset
Generic call
kosmo integrations:call one-signal.onesignal_list_templates '{"app_id":"example_app_id","limit":1,"offset":1}' --json
Shortcut
kosmo integrations:one-signal onesignal_list_templates '{"app_id":"example_app_id","limit":1,"offset":1}' --json

one-signal.onesignal_get_template

Get a message template by ID.

Read read
Parameters
app_id, template_id
Generic call
kosmo integrations:call one-signal.onesignal_get_template '{"app_id":"example_app_id","template_id":"example_template_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_get_template '{"app_id":"example_app_id","template_id":"example_template_id"}' --json

one-signal.onesignal_create_template

Create a reusable push, email, or SMS template.

Write write
Parameters
app_id, payload
Generic call
kosmo integrations:call one-signal.onesignal_create_template '{"app_id":"example_app_id","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_create_template '{"app_id":"example_app_id","payload":"example_payload"}' --json

one-signal.onesignal_update_template

Update a reusable push, email, or SMS template.

Write write
Parameters
app_id, template_id, payload
Generic call
kosmo integrations:call one-signal.onesignal_update_template '{"app_id":"example_app_id","template_id":"example_template_id","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_update_template '{"app_id":"example_app_id","template_id":"example_template_id","payload":"example_payload"}' --json

one-signal.onesignal_delete_template

Delete a message template by ID.

Write write
Parameters
app_id, template_id
Generic call
kosmo integrations:call one-signal.onesignal_delete_template '{"app_id":"example_app_id","template_id":"example_template_id"}' --json
Shortcut
kosmo integrations:one-signal onesignal_delete_template '{"app_id":"example_app_id","template_id":"example_template_id"}' --json

one-signal.onesignal_view_outcomes

View outcome analytics such as clicks, confirmed deliveries, session duration, or custom outcomes.

Read read
Parameters
app_id, outcome_names, outcome_time_range, outcome_platforms, outcome_attribution
Generic call
kosmo integrations:call one-signal.onesignal_view_outcomes '{"app_id":"example_app_id","outcome_names":"example_outcome_names","outcome_time_range":"example_outcome_time_range","outcome_platforms":"example_outcome_platforms","outcome_attribution":"example_outcome_attribution"}' --json
Shortcut
kosmo integrations:one-signal onesignal_view_outcomes '{"app_id":"example_app_id","outcome_names":"example_outcome_names","outcome_time_range":"example_outcome_time_range","outcome_platforms":"example_outcome_platforms","outcome_attribution":"example_outcome_attribution"}' --json

one-signal.onesignal_api_get

Call a safe relative OneSignal API path with GET for endpoints not yet wrapped by a dedicated tool.

Read read
Parameters
path, params
Generic call
kosmo integrations:call one-signal.onesignal_api_get '{"path":"example_path","params":"example_params"}' --json
Shortcut
kosmo integrations:one-signal onesignal_api_get '{"path":"example_path","params":"example_params"}' --json

one-signal.onesignal_api_post

Call a safe relative OneSignal API path with POST for endpoints not yet wrapped by a dedicated tool.

Write write
Parameters
path, payload
Generic call
kosmo integrations:call one-signal.onesignal_api_post '{"path":"example_path","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_api_post '{"path":"example_path","payload":"example_payload"}' --json

one-signal.onesignal_api_patch

Call a safe relative OneSignal API path with PATCH for endpoints not yet wrapped by a dedicated tool.

Write write
Parameters
path, payload
Generic call
kosmo integrations:call one-signal.onesignal_api_patch '{"path":"example_path","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_api_patch '{"path":"example_path","payload":"example_payload"}' --json

one-signal.onesignal_api_delete

Call a safe relative OneSignal API path with DELETE for endpoints not yet wrapped by a dedicated tool.

Write write
Parameters
path, payload
Generic call
kosmo integrations:call one-signal.onesignal_api_delete '{"path":"example_path","payload":"example_payload"}' --json
Shortcut
kosmo integrations:one-signal onesignal_api_delete '{"path":"example_path","payload":"example_payload"}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

one-signal.onesignal_list_notifications 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_list_notifications --json
ParameterTypeRequiredDescription
app_id string yes The OneSignal app ID to list notifications for.
limit integer no Maximum number of notifications to return (default: 50, max: 50).
offset integer no Offset for pagination (default: 0).
one-signal.onesignal_get_notification 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_get_notification --json
ParameterTypeRequiredDescription
id string yes The notification ID to retrieve.
app_id string yes The OneSignal app ID the notification belongs to.
one-signal.onesignal_create_notification 7 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_create_notification --json
ParameterTypeRequiredDescription
app_id string yes The OneSignal app ID to send the notification from.
payload object no Full message payload. If provided, it is sent directly with app_id.
contents object yes Notification body per language, e.g. {"en": "Hello!", "es": "Hola!"}. The "en" key is required.
headings object no Notification title per language, e.g. {"en": "Update"}. Defaults to the app name if omitted.
included_segments array no Segments to target, e.g. ["All", "Active Users"]. Defaults to ["All"] if omitted.
url string no URL to open when the notification is tapped.
data object no Custom key-value data payload delivered to the app when the notification is opened.
one-signal.onesignal_cancel_notification 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_cancel_notification --json
ParameterTypeRequiredDescription
message_id string yes Message or notification ID.
app_id string no OneSignal App ID. Defaults to configured app_id.
one-signal.onesignal_list_devices 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_list_devices --json
ParameterTypeRequiredDescription
app_id string yes The OneSignal app ID to list devices for.
limit integer no Maximum number of devices to return (default: 50, max: 300).
offset integer no Offset for pagination (default: 0).
one-signal.onesignal_get_device 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_get_device --json
ParameterTypeRequiredDescription
id string yes The device/player ID to retrieve.
app_id string yes The OneSignal app ID the device belongs to.
one-signal.onesignal_list_apps 0 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_list_apps --json
ParameterTypeRequiredDescription
No parameters.
one-signal.onesignal_get_current_app 1 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_get_current_app --json
ParameterTypeRequiredDescription
app_id string yes The OneSignal app ID to retrieve.
one-signal.onesignal_update_app 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_update_app --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
payload object yes App update payload.
one-signal.onesignal_create_user 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_create_user --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
payload object yes User payload containing identity, properties, and/or subscriptions.
one-signal.onesignal_get_user 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_get_user --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
alias_label string yes Alias label, usually external_id or onesignal_id.
alias_id string yes Alias value.
one-signal.onesignal_update_user 4 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_update_user --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
alias_label string yes Alias label.
alias_id string yes Alias value.
payload object yes User update payload with properties and/or deltas.
one-signal.onesignal_delete_user 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_delete_user --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
alias_label string yes Alias label.
alias_id string yes Alias value.
one-signal.onesignal_get_user_identity 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_get_user_identity --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
alias_label string yes Alias label.
alias_id string yes Alias value.
one-signal.onesignal_create_or_update_alias 4 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_create_or_update_alias --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
alias_label string yes Known alias label.
alias_id string yes Known alias value.
identity object yes Aliases to add or update.
one-signal.onesignal_delete_alias 4 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_delete_alias --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
alias_label string yes Known alias label.
alias_id string yes Known alias value.
alias_label_to_delete string yes Alias label to remove.
one-signal.onesignal_get_identity_by_subscription 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_get_identity_by_subscription --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
subscription_id string yes Subscription ID.
one-signal.onesignal_create_alias_by_subscription 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_create_alias_by_subscription --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
subscription_id string yes Subscription ID.
identity object yes Aliases to add or update.
one-signal.onesignal_create_subscription 4 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_create_subscription --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
alias_label string yes Alias label for the user.
alias_id string yes Alias value for the user.
payload object yes Subscription payload.
one-signal.onesignal_update_subscription 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_update_subscription --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
subscription_id string yes Subscription ID.
payload object yes Subscription update payload.
one-signal.onesignal_transfer_subscription 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_transfer_subscription --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
subscription_id string yes Subscription ID.
identity object yes Destination identity with exactly one alias.
one-signal.onesignal_list_segments 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_list_segments --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
limit integer no Maximum rows to return.
offset integer no Pagination offset.
one-signal.onesignal_get_segment 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_get_segment --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
segment_id string yes Segment ID.
include-segment-detail boolean no Include segment metadata and filters.
one-signal.onesignal_create_segment 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_create_segment --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
payload object yes Segment payload with name and filters.
one-signal.onesignal_update_segment 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_update_segment --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
segment_id string yes Segment ID.
payload object yes Segment update payload.
one-signal.onesignal_delete_segment 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_delete_segment --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
segment_id string yes Segment ID.
one-signal.onesignal_list_templates 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_list_templates --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
limit integer no Maximum templates to return.
offset integer no Pagination offset.
one-signal.onesignal_get_template 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_get_template --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
template_id string yes Template ID.
one-signal.onesignal_create_template 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_create_template --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
payload object yes Template payload.
one-signal.onesignal_update_template 3 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_update_template --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
template_id string yes Template ID.
payload object yes Template update payload.
one-signal.onesignal_delete_template 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_delete_template --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
template_id string yes Template ID.
one-signal.onesignal_view_outcomes 5 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_view_outcomes --json
ParameterTypeRequiredDescription
app_id string no OneSignal App ID. Defaults to configured app_id.
outcome_names string yes Comma-separated outcome names such as os__click.count.
outcome_time_range string no Time range.
outcome_platforms string no Comma-separated platform IDs.
outcome_attribution string no Attribution type.
one-signal.onesignal_api_get 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_api_get --json
ParameterTypeRequiredDescription
path string yes Relative API path such as /notifications. Absolute URLs are rejected.
params object no Query parameters.
one-signal.onesignal_api_post 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_api_post --json
ParameterTypeRequiredDescription
path string yes Relative API path. Absolute URLs are rejected.
payload object no JSON payload.
one-signal.onesignal_api_patch 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_api_patch --json
ParameterTypeRequiredDescription
path string yes Relative API path. Absolute URLs are rejected.
payload object no JSON payload.
one-signal.onesignal_api_delete 2 parameters
Schema command
kosmo integrations:schema one-signal.onesignal_api_delete --json
ParameterTypeRequiredDescription
path string yes Relative API path. Absolute URLs are rejected.
payload object no JSON payload.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.