OneSignal
OneSignal (opens in a new tab) is a customer engagement platform specializing in push notifications and in-app messaging.
Prerequisites
In order to integrate with OneSignal, you'll need to collect the following information:
| Name | Description |
|---|---|
| Domain* | Your OneSignal URL (default:onesignal.com) |
| App ID* | Your OneSignal App ID. Follow OneSignal's docs to retrieve your App ID (opens in a new tab) |
| API key* | Your REST API Key. Follow OneSignal's docs to retrieve your REST API Key (opens in a new tab) |
| Player ID* | The location in your owned database where you store OneSignal Player IDs in the following format: _dataset.collection.field_ |
Integrating with OneSignal
To integrate an existing system with OneSignal:
- Navigate to Data map → View Systems and choose the system that you want to connect.
- Click on the Integrations tab.
- Pick the vendor or system type that you want to integrate with from the Connection type drop-down menu.
- Complete the required fields for the integration and click Save.
You may confirm your connection is working using the Test connection button, if desired.
To learn more, please see our guide for Managing Integrations.
Technical detail
Fides utilizes API endpoints to access the API service for a SaaS application. An API service is the programmatic interface through which Fides can query and update data within an application to access, rectify, or delete personal information. Each SaaS tool will have a unique set of endpoints to enable privacy functions.
OneSignal endpoints
In the table below, you can find which endpoints are used for each type of privacy function. Clicking on the endpoint will take you to the documentation for that endpoint.
| Privacy function | Endpoint | Description |
|---|---|---|
| Access Requests | Devices (opens in a new tab) | Returns information about a user's device in your OneSignal app |
| Update or Erasure Requests | Devices (opens in a new tab) | Used to erase information about a user |