# PushEngage

### Snapshot

| Features                        | Details                                          |
| ------------------------------- | ------------------------------------------------ |
| Release Status                  | Released                                         |
| Source API Version              | v1                                               |
| Table Selection                 | Yes                                              |
| Column Selection                | Yes                                              |
| Edit Integration                | Yes                                              |
| Replication Type Selection      | No                                               |
| Authentication Parameters       | PushEngage API Key                               |
| Replication Type                | <p>Full Replication<br>Key Based Incremental</p> |
| Replication Key                 | Date                                             |
| Suggested Replication Frequency | 24 hrs                                           |

| Tables/APIs Supported |                        |
| --------------------- | ---------------------- |
| SentNotifications     | ScheduledNotifications |
| DraftNotifications    |                        |

### Pre-requisites

1. Generate PushEngage API Key for Daton
2. Read more on How to get your PushEngage API Key at <https://docs.sarasanalytics.com/faqs/source-api-keys/pushengage-api-key>

### Integrate PushEngage with Daton

1. Signin to Daton&#x20;
2. Select PushEngage from Integrations page
3. Provide Integration Name, Replication Frequency, and History. Integration name would be used in creating tables for the integration and cannot be changed later&#x20;
4. Provide PushEngage API Key
5. Post successful authentication, you will be prompted to choose from the list of available tables
6. Then select all required fields for each table
7. Submit the integration

### Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### PushEngage Data

**SentNotifications**

Purpose: This endpoint is used to list all notification created by users with status "sent".

Source API Documentation  <https://www.pushengage.com/api/notifications/list-sent/>

Replication: Key-Based Replication

Replication Key: start\_date

**Fields**

| Name                  | Target Datatype |
| --------------------- | --------------- |
| notification\_id      | STRING          |
| notification\_title   | STRING          |
| notification\_message | STRING          |
| notification\_url     | STRING          |
| notification\_image   | STRING          |
| sent\_time            | datetime        |
| statistics            | RECORD          |

**ScheduledNotifications**

Purpose: This endpoint is used to list all notification created by users with status "later".

Source API Documentation  <https://www.pushengage.com/api/notifications/list-scheduled/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                  | Target Datatype |
| --------------------- | --------------- |
| notification\_id      | STRING          |
| notification\_title   | STRING          |
| notification\_message | STRING          |
| notification\_url     | STRING          |
| notification\_image   | STRING          |
| sent\_time            | datetime        |
| statistics            | RECORD          |

**DraftNotifications**

Purpose: This endpoint is used to list all notification created by users with status as "draft".

Source API Documentation  <https://www.pushengage.com/api/notifications/list-draft/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                  | Target Datatype |
| --------------------- | --------------- |
| notification\_id      | STRING          |
| notification\_title   | STRING          |
| notification\_message | STRING          |
| notification\_url     | STRING          |
| notification\_image   | STRING          |
| sent\_time            | datetime        |
| statistics            | RECORD          |