> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vindicia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Setting Up Push Notifications

Push notifications are defined as Events (messages) or Classes of Events (categories) and you can decide which you want to receive and monitor. Vindicia Client Technical Support enables and configures the receipt of Push Notifications for you and allows you to define which events or event classes you want to receive.

You can subscribe to receive push notifications of complete or partial Event Classes, and of individual Events. You can subscribe to unlimited merchant push subscriptions for a given Event or Event Class. This allows you to have the same Events or Classes of Events trigger Push Messages to multiple targets (listeners), each with its own rules, endpoint, security and retry configuration. For details, see [Setting Up Push Notification Listener](Setting_up_a_Listener).

## Push Notification Required Info

For each subscription you'd like to set up, you will need to provide Vindicia Support the following details.

You can fill in the details in the Excel form available to download at the bottom of the page and provide to Vindicia Client Technical Support.

## Push Notification Setup - General Info

The following general details are needed for Push Notification deployment:

* **Event Class name** or **Event name** if you are subscribing to individual Events

* **Excluded events**: A list of Events you want excluded from Event Classes—for example, you might want to receive notifications of only some of the Events in the  Retain Event Class. In that case you would provide Support with the name of the Event/s you want excluded from that Event Class.

  See [Retain Push Event Classes and Events](Push_Event_Classes_and_E).

* **Endpoints**: The endpoints (listeners) you would like defined.

  Endpoints could be URLs, optionally with a port number. For example:

  `[https://acme.company.com/Entitlements:443](https://acme.company.com/Entitlements:443)`

* If opting for **HTTP Basic Authentication**: Username and Password

## Push Notification Setup - Push 1.0 Info

The following details are needed for a **Push 1.0** deployment:

* **Notification format**: Select either JSON or URL-encoded.

  **Note:** Push 2.0 only supports JSON format.

* **Retry options**:
  * Count: the number of times you want Vindicia to continue retrying HTTP POST calls
  * Interval: the number of seconds between retries

* **Error Email Address**: the email address to receive optional error notifications.

## Push Notification Setup - Push 2.0 Info

The following details are needed for a **Push 2.0** deployment:

* If opting for **OAuth 2.0 Authentication**, provide the following:
  * **OAuth 2.0 Server URL**: Your identity provider OAuth server URL for token retrieval.

    For example `[https://uulp.stag-ozd9rfhux3s8fi2s.us.auth0.com/oauth/token](https://uulp.stag-ozd9rfhux3s8fi2s.us.auth0.com/oauth/token)`

  * **Audience**: Your identity provider app for setup or integration.

  * **Username and Password**: Credentials for Vindicia to access the Oauth server to get initial token.
* **Event Timestamp Accuracy**: Select whether you'd like to have the event timestamp detailed to the second or to the millisecond.

  For example, elect between:

  * 2022-09-09T17:09:41.000000+0000 (second)
  * 2022-09-09T17:18:04.561936 (millisecond)
    See [Push Notification Listener](Setting_up_a_Listener)

\[<img src="https://mintcdn.com/vindicia-retain/pL1W6dYumVz09Ch6/portal/retainImplementationGuide/images/download_button.png?fit=max&auto=format&n=pL1W6dYumVz09Ch6&q=85&s=aa857d925f301056f15c5ba23d6f1800" alt="" width="150" height="38" data-path="portal/retainImplementationGuide/images/download_button.png" />

]\(../images/PushNotificationSetupRequest.xlsx)

**Parent topic:**[Push Notifications](../topics/ProgGuide_PushNotifications)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.