OneSignal

Push notification and messaging platform for iGaming player engagement and retention.

Detail	Value
Category	iGaming
Base URL	https://api.onesignal.com
Authentication	API Key
Endpoints	11
Connector key	onesignal

Using OneSignal in a workflow

1. Go to Connections and click New Connection.
2. Pick OneSignal from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

Endpoint	Summary
POST /notifications	Create and send a notification
GET /notifications	List notifications
GET /notifications/{notification_id}	Get notification
POST /apps/{app_id}/users	Create user
GET /apps/{app_id}/users/by/{alias_label}/{alias_id}	Get user by alias
PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}	Update user
DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}	Delete user
POST /apps/{app_id}/segments	Create segment
DELETE /apps/{app_id}/segments/{segment_id}	Delete segment
POST /apps/{app_id}/custom_events	Track custom events
POST /templates	Create template

Each endpoint is documented in full below. Use the outline on the right to jump to one.

POST /notifications

Create and send a notification

Detail	Value
Operation ID	igaming.createNotification
Method	POST
Path	/notifications

Parameters

No parameters.

Request Body

Field	Type
app_id	string
contents	object
included_segments	array

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.createNotification.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

GET /notifications

List notifications

Detail	Value
Operation ID	igaming.listNotifications
Method	GET
Path	/notifications

Parameters

Name	Location	Type	Required
app_id	query	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.listNotifications.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

GET /notifications/{notification_id}

Get notification

Detail	Value
Operation ID	igaming.getNotification
Method	GET
Path	/notifications/{notification_id}

Parameters

Name	Location	Type	Required
notification_id	path	string	Yes
app_id	query	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.getNotification.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

POST /apps/{app_id}/users

Create user

Detail	Value
Operation ID	igaming.createUser
Method	POST
Path	/apps/{app_id}/users

Parameters

Name	Location	Type	Required
app_id	path	string	Yes

Request Body

Field	Type
identity	object
properties	object

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.createUser.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

GET /apps/{app_id}/users/by/{alias_label}/{alias_id}

Get user by alias

Detail	Value
Operation ID	igaming.getUser
Method	GET
Path	/apps/{app_id}/users/by/{alias_label}/{alias_id}

Parameters

Name	Location	Type	Required
app_id	path	string	Yes
alias_label	path	string	Yes
alias_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.getUser.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}

Update user

Detail	Value
Operation ID	igaming.updateUser
Method	PATCH
Path	/apps/{app_id}/users/by/{alias_label}/{alias_id}

Parameters

Name	Location	Type	Required
app_id	path	string	Yes
alias_label	path	string	Yes
alias_id	path	string	Yes

Request Body

Field	Type
properties	object

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.updateUser.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}

Delete user

Detail	Value
Operation ID	igaming.deleteUser
Method	DELETE
Path	/apps/{app_id}/users/by/{alias_label}/{alias_id}

Parameters

Name	Location	Type	Required
app_id	path	string	Yes
alias_label	path	string	Yes
alias_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.deleteUser.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

POST /apps/{app_id}/segments

Create segment

Detail	Value
Operation ID	igaming.createSegment
Method	POST
Path	/apps/{app_id}/segments

Parameters

Name	Location	Type	Required
app_id	path	string	Yes

Request Body

Field	Type
name	string
filters	array

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.createSegment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

DELETE /apps/{app_id}/segments/{segment_id}

Delete segment

Detail	Value
Operation ID	igaming.deleteSegment
Method	DELETE
Path	/apps/{app_id}/segments/{segment_id}

Parameters

Name	Location	Type	Required
app_id	path	string	Yes
segment_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.deleteSegment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

POST /apps/{app_id}/custom_events

Track custom events

Detail	Value
Operation ID	igaming.trackCustomEvents
Method	POST
Path	/apps/{app_id}/custom_events

Parameters

Name	Location	Type	Required
app_id	path	string	Yes

Request Body

Field	Type
events	array

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.trackCustomEvents.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.

POST /templates

Create template

Detail	Value
Operation ID	igaming.createTemplate
Method	POST
Path	/templates

Parameters

No parameters.

Request Body

Field	Type
app_id	string
name	string
contents	object

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your OneSignal connection from the Connection dropdown.
3. In the Operation dropdown, select igaming.createTemplate.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream OneSignal API reference.