Onesignal user auth

Learn how to use Onesignal user auth with Composio

Overview

SLUG: ONESIGNAL_USER_AUTH

Description

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

Authentication Details

generic_api_key
stringRequired

Connecting to Onesignal user auth

Create an auth config

Use the dashboard to create an auth config for the Onesignal user auth toolkit. This allows you to connect multiple Onesignal user auth accounts to Composio for agents to use.

1

Select App

Navigate to [Onesignal user auth](https://platform.composio.dev?next_page=/marketplace/Onesignal user auth).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Onesignal user auth Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4onesignal_user_auth_auth_config_id = "ac_YOUR_ONESIGNAL_USER_AUTH_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Onesignal user auth for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, onesignal_user_auth_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Onesignal user auth toolkit’s playground](https://app.composio.dev/app/Onesignal user auth)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["ONESIGNAL_USER_AUTH"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add or Update Device Tags

Description

Tool to assign or update tags on a onesignal device. use when you need to apply or change custom tags for a player for segmentation.

Action Parameters

app_id
stringRequired
player_id
stringRequired
tags
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Edit OneSignal Device

Description

Tool to update an existing onesignal device (player) record. use when you have the player id and need to modify device attributes.

Action Parameters

ad_id
string
amount_spent
number
app_id
string
badge_count
integer
country
string
created_at
integer
device_model
string
device_os
string
game_version
string
identifier
string
language
string
last_active
integer
lat
number
long
number
notification_types
integer
player_id
stringRequired
playtime
integer
sdk
string
session_count
integer
tags
object
timezone
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View OneSignal Segment

Description

Tool to retrieve details for a specific onesignal segment. use when you need to inspect segment definition.

Action Parameters

app_id
stringRequired
segment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View App

Description

Tool to retrieve details for a specific onesignal app. use after authenticating to inspect app settings.

Action Parameters

app_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View OneSignal Device

Description

Tool to retrieve details for a specific device/player. use when you have a player id and optional app id.

Action Parameters

app_id
string
player_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Segments

Description

Tool to list all segments for an app. use after obtaining the app id to retrieve a paginated list of segments.

Action Parameters

app_id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View OneSignal Device Tags

Description

Tool to get tags assigned to a device. use when you need to fetch key/value tags for a specific onesignal player.

Action Parameters

app_id
stringRequired
player_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired