Skip to main content

Authorization

Follow this guide to create a new OneSignal credential that will allow Nexla to authenticate to and exchange data with your OneSignal account.
onesignal_api_auth.png

OneSignal

Prerequisites​

Before creating a OneSignal credential, you'll need to obtain a REST API Key and App ID from your OneSignal account. OneSignal provides API keys for programmatic access to their customer engagement platform through the OneSignal dashboard.

To obtain OneSignal API credentials:

  1. Log in to your OneSignal account at https://onesignal.com or your organization's OneSignal instance.

  2. Navigate to Settings > Keys & IDs in your OneSignal dashboard. This section contains your API keys and app identifiers.

  3. In the Keys & IDs section, locate your REST API Key. This is the API key used for authenticating REST API requests. You can use either:

    • REST API Key: For managing a specific app (recommended for most use cases)
    • User Auth Key: For managing multiple apps across your account

  4. Copy the REST API Key or User Auth Key depending on your needs. Store it securely, as you'll need it to authenticate API requests.

  5. Note your App ID. This is the unique identifier for your OneSignal app, found in the same Keys & IDs section. The App ID is required for most API requests to specify which app you're working with.

OneSignal API keys are used as Bearer tokens in the Authorization header for all API requests. The API key is sensitive information and should be kept secure. If you've lost your API key, you can view it again in the Keys & IDs section of your OneSignal dashboard. The App ID is required for most API operations to identify the specific app you're working with.

For detailed information about OneSignal API authentication and API key management, refer to the OneSignal REST API Documentation and OneSignal Accounts and Keys Guide.

Create a OneSignal Credential​

  • To create a new OneSignal credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – OneSignal

OneSignalCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Credential Settings​

  1. In the REST API Key field (or User Auth Key field if using User Auth Key authentication), enter the API key that you obtained from your OneSignal dashboard. This is the secret API key used to authenticate requests to the OneSignal API.

  2. In the App ID field, enter your OneSignal App ID that you obtained from your OneSignal dashboard. This is the unique identifier for your OneSignal app and is required for most API operations.

    The API key is sensitive information and should be kept secure. If you've lost your API key, you can view it again in the Keys & IDs section of your OneSignal dashboard. API keys are used as Bearer tokens in the Authorization header for all API requests.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.