# Onesignal user auth

```json
{
  "name": "Onesignal user auth",
  "slug": "onesignal_user_auth",
  "url": "https://composio.dev/toolkits/onesignal_user_auth",
  "markdown_url": "https://composio.dev/toolkits/onesignal_user_auth.md",
  "logo_url": "https://logos.composio.dev/api/onesignal_user_auth",
  "categories": [
    "marketing & social media"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:20:42.149Z"
}
```

![Onesignal user auth logo](https://logos.composio.dev/api/onesignal_user_auth)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Onesignal user auth MCP or direct API to send push notifications, manage user segments, automate messaging, and track engagement through natural language.

## Summary

OneSignal is a customer engagement platform for push notifications, email, SMS, and in-app messaging. It streamlines how businesses reach, engage, and retain their users across channels.

## Categories

- marketing & social media

## Toolkit Details

- Tools: 12

## Images

- Logo: https://logos.composio.dev/api/onesignal_user_auth

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for OneSignal User Auth.
  - Setup:
    - Configure Api Key credentials for OneSignal User Auth.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Update device tags for a specific user
- List all segments in my app
- Fetch tags assigned to player ID 123
- Get details of a particular OneSignal segment

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `ONESIGNAL_USER_AUTH_CREATE_USER` | Create or Update OneSignal User | Tool to create a new user or modify the subscriptions associated with an existing user. Use when you need to register a user with OneSignal or update their subscriptions. |
| `ONESIGNAL_USER_AUTH_DELETE_ALIAS` | Delete User Alias | Tool to remove an alias from a OneSignal user. Use when you need to delete a specific alias identifier from a user while preserving other aliases. The user is identified by one alias (alias_label/alias_id) and a different alias (alias_label_to_delete) is removed. |
| `ONESIGNAL_USER_AUTH_EDIT_DEVICE` | Edit OneSignal Device | Tool to update an existing OneSignal device (player) record. Use when you have the player_id and need to modify device attributes. |
| `ONESIGNAL_USER_AUTH_ONESIGNAL_VIEW_SEGMENT` | View OneSignal Segment | Tool to retrieve the subscriber count for a specific OneSignal segment. Use when you need to know how many subscribers are in a segment. |
| `ONESIGNAL_USER_AUTH_UPDATE_SUBSCRIPTION_BY_TOKEN` | Update Subscription By Token | Tool to update properties on an existing subscription using its token. Use when you need to enable or disable subscription status when managing outside of the OneSignal SDK. |
| `ONESIGNAL_USER_AUTH_VIEW_APP` | View App | Tool to retrieve details for a specific OneSignal app. Use after authenticating to inspect app settings. |
| `ONESIGNAL_USER_AUTH_VIEW_BROADCASTS` | View Broadcasts | Tool to view inbox broadcasts for a OneSignal app. Returns broadcasts in descending order of creation. Use when retrieving in-app messages or inbox content for an app. |
| `ONESIGNAL_USER_AUTH_VIEW_DEVICE` | View OneSignal Device | Tool to retrieve details for a specific device/player. Use when you have a player_id and optional app_id. |
| `ONESIGNAL_USER_AUTH_VIEW_OUTCOMES` | View Outcomes | Tool to view all outcomes associated with a OneSignal app. Use to retrieve outcome metrics filtered by time range, platforms, and attribution type. |
| `ONESIGNAL_USER_AUTH_VIEW_SEGMENTS` | View Segments | Tool to list all segments for an app. Use after obtaining the app_id to retrieve a paginated list of segments. |
| `ONESIGNAL_USER_AUTH_VIEW_USER` | View OneSignal User | Tool to retrieve user details by alias label and ID. Use when you need to fetch user data including tags, subscriptions, and identity information. |
| `ONESIGNAL_USER_AUTH_VIEW_USER_UNREAD_MESSAGE_COUNT` | View User Unread Message Count | Tool to retrieve the unread message count for a specific user. Use when you need to check how many unread inbox messages a user has. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Onesignal user auth Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Onesignal user auth actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Update tags for device with player ID 12345 to segment users interested in promotions.'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Update tags for device with player ID 12345 to segment users interested in promotions.'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Onesignal user auth tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('View device tags for player ID 12345')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'View device tags for player ID 12345' }],
  stopWhen: stepCountIs(5)
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Onesignal user auth Integration

- Supports both Onesignal user auth MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Onesignal user auth data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Onesignal user auth access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Onesignal user auth
- Scoped, least privilege access to Onesignal user auth resources
- Full audit trail of agent actions to support review and compliance

## Use Onesignal user auth with any AI Agent Framework

Choose a framework you want to connect Onesignal user auth with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/onesignal_user_auth/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/onesignal_user_auth/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/onesignal_user_auth/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/onesignal_user_auth/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/onesignal_user_auth/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/onesignal_user_auth/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/onesignal_user_auth/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/onesignal_user_auth/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/onesignal_user_auth/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/onesignal_user_auth/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/onesignal_user_auth/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/onesignal_user_auth/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/onesignal_user_auth/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/onesignal_user_auth/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/onesignal_user_auth/framework/autogen)

## Related Toolkits

- [Reddit](https://composio.dev/toolkits/reddit) - Reddit is a social news platform with thriving user-driven communities (subreddits). It's the go-to place for discussion, content sharing, and viral marketing.
- [Facebook](https://composio.dev/toolkits/facebook) - Facebook is a social media and advertising platform for businesses and creators. It helps you connect, share, and manage content across your public Facebook Pages.
- [Linkedin](https://composio.dev/toolkits/linkedin) - LinkedIn is a professional networking platform for connecting, sharing content, and engaging with business opportunities. It's the go-to place for building your professional brand and unlocking new career connections.
- [Active campaign](https://composio.dev/toolkits/active_campaign) - ActiveCampaign is a marketing automation and CRM platform for managing email campaigns, sales pipelines, and customer segmentation. It helps businesses engage customers and drive growth through smart automation and targeted outreach.
- [ActiveTrail](https://composio.dev/toolkits/active_trail) - ActiveTrail is a user-friendly email marketing and automation platform. It helps you reach subscribers and automate campaigns with ease.
- [Ahrefs](https://composio.dev/toolkits/ahrefs) - Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic.
- [Amcards](https://composio.dev/toolkits/amcards) - AMCards lets you create and mail personalized greeting cards online. Build stronger customer relationships with easy, automated card campaigns.
- [Beamer](https://composio.dev/toolkits/beamer) - Beamer is a news and changelog platform for in-app announcements and feature updates. It helps companies boost user engagement by sharing news where users are most active.
- [Benchmark email](https://composio.dev/toolkits/benchmark_email) - Benchmark Email is a platform for creating, sending, and tracking email campaigns. It's built to help you engage audiences and analyze results—all in one place.
- [Bigmailer](https://composio.dev/toolkits/bigmailer) - BigMailer is an email marketing platform for managing multiple brands with white-labeling and automation. It helps teams streamline campaigns and simplify integration with Amazon SES.
- [Brandfetch](https://composio.dev/toolkits/brandfetch) - Brandfetch is an API that delivers company logos, colors, and visual branding assets. It helps marketers and developers keep brand visuals consistent everywhere.
- [Brevo](https://composio.dev/toolkits/brevo) - Brevo is an all-in-one email and SMS marketing platform for transactional messaging, automation, and CRM. It helps businesses engage customers and streamline communications through powerful campaign tools.
- [Campayn](https://composio.dev/toolkits/campayn) - Campayn is an email marketing platform for creating, sending, and managing campaigns. It helps businesses engage contacts and grow audiences with easy-to-use tools.
- [Cardly](https://composio.dev/toolkits/cardly) - Cardly is a platform for creating and sending personalized direct mail to customers. It helps businesses break through the digital clutter by getting real engagement via physical mailboxes.
- [ClickSend](https://composio.dev/toolkits/clicksend) - ClickSend is a cloud-based SMS and email marketing platform for businesses. It streamlines communication by enabling quick message delivery and contact management.
- [Crustdata](https://composio.dev/toolkits/crustdata) - CrustData is an AI-powered data intelligence platform for real-time company and people data. It helps B2B sales teams, AI SDRs, and investors react to live business signals.
- [Curated](https://composio.dev/toolkits/curated) - Curated is a platform for collecting, curating, and publishing newsletters. It streamlines content aggregation and distribution for creators and teams.
- [Customerio](https://composio.dev/toolkits/customerio) - Customer.io is a customer engagement platform for targeted messaging across email, SMS, and push. Easily automate, segment, and track communications with your audience.
- [Cutt ly](https://composio.dev/toolkits/cutt_ly) - Cutt.ly is a URL shortening service for managing and analyzing links. Streamline your workflows with quick, trackable, and branded short URLs.
- [Demio](https://composio.dev/toolkits/demio) - Demio is webinar software built for marketers, offering both live and automated sessions with interactive features. It helps teams engage audiences and optimize lead generation through detailed analytics.

## Frequently Asked Questions

### Do I need my own developer credentials to use Onesignal user auth with Composio?

Yes, Onesignal user auth requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)