> For the complete documentation index, see [llms.txt](https://documentation.freshpaint.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.freshpaint.io/integrations/destinations/apps/one-signal/onesignal-quick-start-guide.md).

# OneSignal Quick Start Guide

OneSignal is a messaging service that lets you send push notifications and emails to your customers.

Freshpaint helps teams manage and control their customer data. Freshpaint automatically captures every click, pageview, and form submission. This makes it possible for non-technical users to route data from Freshpaint to any marketing or analytics platform.

With Freshpaint and OneSignal, you can can use Freshpaint to attach user metadata to your users in OneSignal and create customized messaging campaigns for your customers.

## Destination Information

* Accepts [identify](https://documentation.freshpaint.io/readme/setting-up-identify) calls.
* Supports [HIPAA mode](https://documentation.freshpaint.io/hipaa-mode)
* Connection Modes:

<table><thead><tr><th align="right"></th><th data-type="checkbox">Client-side</th><th data-type="checkbox">Server-side</th></tr></thead><tbody><tr><td align="right">Web</td><td>false</td><td>true</td></tr><tr><td align="right">Mobile</td><td>false</td><td>true</td></tr><tr><td align="right">Server</td><td>false</td><td>true</td></tr></tbody></table>

## Getting Started

### What You'll Need

* [OneSignal Account](https://onesignal.com/pricing)
* OneSignal App ID (found under Settings > Keys and IDs)
* Freshpaint account with [identify calls set up](https://documentation.freshpaint.io/readme/setting-up-identify).

{% hint style="info" %}
Before you can pass Freshpaint data to OneSignal, you'll need to [install the Freshpaint javascript SDK](https://documentation.freshpaint.io/readme/quickstart/installing-freshpaint), and have [identify calls set up](https://documentation.freshpaint.io/readme/setting-up-identify).
{% endhint %}

1. **From within Freshpaint, navigate to Destinations > Overview and search for OneSignal. Select Details.**

<figure><img src="/files/844aauYJkQDihWVoz5e1" alt=""><figcaption></figcaption></figure>

**2. Insert your OneSignal App ID (found under Settings > Keys and IDs)**

<figure><img src="/files/qlaqQjusV7mCVYaFhO2K" alt=""><figcaption></figcaption></figure>

![](/files/g1TaMSKTp0DOLTCT7WOh)

**3. That's it! You should now see the** [**enabled status**](/readme/setting-up-your-destinations/enabling-and-disabling-a-destination.md) **next to OneSignal:**

![](/files/zjQqy8XqWHcxiUyAFRJ1)

## Confirm events are sending to OneSignal as expected

OneSignal does not support events from Freshpaint as it does not have the concept of events. It will only update Data Tags which will map to user properties. You can view Data Tags for a user under Audience > Subscriptions or Users and then select the user.

<figure><img src="/files/jbVYpWfVLQUy1L9ujon3" alt=""><figcaption></figcaption></figure>

Read more about managing users in OneSignal [here](https://documentation.onesignal.com/docs/users).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.freshpaint.io/integrations/destinations/apps/one-signal/onesignal-quick-start-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
