Skip to content
Changelog

Report a bug

OneSignal User Auth integration: operations for AI agents

OneSignal User Auth connects to Type.com as an integration. This page lists the 67 operations documented for Claude and Codex in Type.com: 25 read, 33 write, 9 destructive.

About OneSignal User Auth

OneSignal is a customer engagement platform offering push notifications, email, SMS, and in-app messaging services.

Categories: Email & Messaging

How to connect OneSignal User Auth to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

67 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

67 operations listed.

Apps

  • Read

    View apps

    Retrieve a list of all OneSignal apps associated with your account, including key app details like name, App ID, subscription counts, and timestamps. Useful for managing multiple apps through the OneSignal API.

  • Read

    View an app

    View the details of a single OneSignal app

  • Read

    View segments

    Retrieve a list of segments associated with a specific OneSignal app. Useful for programmatically accessing segment metadata such as name, creation date, and status.

  • Read

    View segment

    Retrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters.

  • Read

    View outcomes

    View and export push notification outcome metrics such as clicks, conversions, and custom events.

  • Read

    View user

    Retrieve a user including aliases, properties, and subscriptions.

  • Read

    View user identity

    Retrieve all aliases associated with a user using a known alias, such as an externalid, onesignalid, or a custom alias. This API helps you map back to a user's full identity from any one piece of identifying information.

  • Read

    View user identity (by subscription)

    Retrieve all aliases linked to a user using a known subscriptionid. This is useful when the user's identity is unknown but you have access to one of their push, email, or SMS subscriptions.

  • Read

    View broadcasts

    Lists all inbox broadcasts sent to an audience.

  • Read

    View user broadcasts

    Lists all inbox broadcasts specifically sent to a unique user.

  • Read

    View user unread message count

    Returns the number of unread messages in a user's inbox.

  • Read

    View API keys

    View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app.

  • Read

    View journeys

    Retrieve a paginated list of journeys for an app. Returns a summary representation of each journey; use View journey for the full configuration. Uses forward-only cursor-based pagination.

  • Read

    View journey

    Retrieve the full configuration of a single journey by its UUID, including its audience and node graph.

  • Read

    View 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.

  • Read

    Get email reputation statistics

    Get email bounce and spam complaint rates received for the app over the last 24 hours, 7 days, and 30 days.

  • Read

    Get email inbox provider metrics

    Get email delivery, open, click, bounce, failure, and spam complaint counts for a sending domain, broken down by inbox provider.

  • Read

    Get 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.

  • Write

    Create an app

    Programmatically create a new OneSignal app via the REST API. This guide explains required fields, supported platform configurations (Web, Android, iOS), and how to properly authenticate using your Organization API key.

  • Write

    Create segment

    Programmatically create segments in your OneSignal app using flexible filters and targeting rules.

  • Write

    Update segment

    Update an existing segment's name and/or filters. The name parameter is always required. When filters are provided, all existing filters are replaced with the new ones.

  • Write

    Update subscription

    Update properties on an existing OneSignal subscription using its subscriptionid. Commonly used to enable or disable a subscription when managing outside of the OneSignal SDK.

  • Write

    Update subscription By Token

    Update properties on an existing Subscription using its token. Commonly used to enable or disable subscription status when managing outside of the OneSignal SDK.

  • Write

    Create Subscription by alias

    Attach a new subscription (email, SMS, or push) to an existing OneSignal user identified by an alias.

  • Write

    Update user

    Modify a user's properties.

  • Write

    Create user

    Create a new user or modify the subscriptions associated with an existing User.

  • Write

    Create or update alias

    Create or update one or more user aliases when you already know an existing alias. This API upserts the user's identity object: it adds new aliases or updates existing ones.

  • Write

    Transfer subscription

    Transfer a Subscription to a different user within the same OneSignal app. Useful for associating existing Subscriptions like push, email, or SMS with a new or updated user identity.

  • Write

    Create alias (by subscription)

    Create or update an alias for a user using a known subscription ID.

  • Write

    Unsubscribe email (with token)

    Unsubscribe an email address from future messages by calling this API from your custom unsubscribe page. Automatically disables the associated email subscription using a token-based approach.

  • Write

    Update Live Activity

    Update or terminate running iOS Live Activities using OneSignal's Live Activities API. This endpoint enables real-time content updates and activity termination, ensuring dynamic, context-aware user experiences.

  • Write

    Start Live Activity

    Remotely start a Live Activity on iOS devices via OneSignal's REST API. Define the activity type, target users, and send dynamic, updatable content directly to a Live Activity interface.

  • Write

    Create inbox broadcast message

    Broadcast a message to users' inboxes.

  • Write

    Bulk update or delete message state

    Updates the read, opened, or deleted state of multiple inbox messages for a user in a single request.

  • Write

    Update message state

    Updates the read, opened, or deleted state of a single inbox message.

  • Write

    Create API key

    Use the OneSignal API to create a new Rich Authentication Token (App API Key) for a specific app. This guide explains how to authenticate with the Organization API key and configure optional IP allowlists using CIDR notation.

  • Write

    Update API key

    Update a Rich Authentication Token (App API Key) for a OneSignal app. Modify the token's name or IP allowlist settings using your Organization API Key.

  • Write

    Rotate API key

    Rotate an existing App API Key (Rich Authentication Token) for a OneSignal app. Useful when a token is compromised or needs replacement without creating a new key from scratch.

  • Write

    Create Custom Events

    The Custom Events API allows you to record user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones.

  • Write

    Create 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. Send an empty nodes array to create a journey with only its required defaults.

  • Write

    Update journey

    Apply a partial update to a journey using JSON Merge Patch (RFC 7396). Send only the fields you want to change; omitted fields are left unchanged. A null value clears a nullable field, and arrays such as nodes are replaced wholesale rather than merged element-wise.

  • Write

    Update journey node

    Apply a partial update to a single node, located by its server-assigned id, using JSON Merge Patch (RFC 7396). Send only the node fields you want to change; the rest of the node and the rest of the journey graph are left untouched, so in-flight users are preserved.

  • Write

    Duplicate 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. To shape the copy in the same request, send overrides. It is a journey document that is applied over the copy as a JSON Merge Patch (RFC 7396).

  • Destructive

    Update an app

    Use to update the name or push platform configuration of an existing app. This guide explains required parameters and platform-specific update rules

  • Destructive

    Delete segment

    Delete segments from OneSignal. Does not delete users or subscriptions.

  • Destructive

    Delete subscription

    Delete a specific subscription by its subscriptionid. This stops messages from being sent to that subscription but does not prevent future subscriptions with the same token.

  • Destructive

    Delete user

    Delete a user including all associated properties, subscriptions, and identity.

  • Destructive

    Delete alias

    Remove a specific alias from a user.

  • Destructive

    Delete API key

    Delete a specific Rich Authentication Token (App API Key) for a OneSignal app. Requires your Organization API Key and the token's unique ID, not the token value itself.

  • Destructive

    Delete journey

    Permanently delete a journey by its UUID. Returns { "success": true } on success. The authenticated App API key must have permission to delete journeys. Deleting a journey stops any in-flight users and cannot be undone.

Players

  • Read

    Export subscriptions CSV

    Generate a GZip-compressed CSV export of your current subscription data using this API endpoint.

Notifications

  • Read

    Export audience activity CSV

    Export a compressed CSV report of audience-level delivery and engagement data for a specific message. This includes sent, delivered, clicked, failed, and unsubscribed events across Push, Email, and SMS channels.

  • Read

    View message

    View the details of a single message and the Outcomes associated with it.

  • Write

    Message history

    View which subscriptions received a particular message

  • Write

    Estimate notification recipients

    Returns the estimated number of recipients for a notification's targeting, without creating or sending anything.

  • Destructive

    Cancel message

    Stop a scheduled or currently outgoing message.

Templates

  • Read

    View template

    Retrieve the details of a specific message template in your OneSignal app using its template ID. This API returns the template content, target channel, and timestamps for creation and last update.

  • Write

    Update template

    Update existing OneSignal message templates for push, email, or SMS. Changes apply immediately across dashboard and API usage via the templateid reference.

  • Write

    Create template

    Create reusable message templates for push, email, and SMS channels. Templates can be accessed through both the dashboard and API using a templateid.

  • Write

    Copy template to another app

    Create a duplicate of a OneSignal message template in another app within the same organization. The new template will retain the same content but have a unique template ID.

  • Destructive

    Delete template

    Permanently delete a specific message template from your OneSignal app using its template ID. Templates used in Journeys must be removed from those Journeys before deletion.

Templates?app id={app id}&limit={limit}&offset={offset}

  • Read

    View templates

    Retrieve a paginated list of message templates from your OneSignal app. This endpoint returns summary information for each template, including ID, name, creation, and update timestamps.

Notifications?c=email

  • Write

    Email

    Send a message using the email channel.

Notifications?c=push

  • Write

    Push notification

    Send a message using the push notification channel.

Notifications?c=sms

  • Write

    SMS

    Send a message using the SMS channel.

Notifications?app id={app id}&limit={limit}&offset={offset}&kind={kind}&template id={template id}&time offset={time offset}

  • Read

    View messages

    View the details for a collection of messages.

Organizations

  • Read

    List audit logs

    Retrieve a paginated, time-scoped list of audit log events for an organization. Requires an Enterprise plan with the audit logs entitlement enabled.

See How connections work for access and permissions, or browse all integrations.