Push Notifications

Push Notifications are real-time notifications sent from our servers to yours on events such as an email open, a link click, a reply or a tracked email. Push Notifications will enable organizations to integrate Bananatag into their internal systems and, coupled with the API, it will allow developers to create integrations with third parties.

Notifications

Send Notification

Notification Parameters
Parameter Type Description
email_id string The id of the email that was opened.
type string The type of push event.
event_at timestamp Datetime of the open.
sent_at timestamp Datetime that the email was sent.
Subject string Email subject line.
is_scheduled boolean Whether the email was a scheduled email or not.
recipients array Array of recipient objects.
recipient . recipient_id string Recipient id.
recipient . recipient_name string Name of recipient.
recipient . recipient_email string Email of recipient.

Open Notification

Notification Parameters
Parameter Type Description
email_id string The id of the email that was opened.
type string The type of push event.
event_at timestamp Datetime of the open.
sent_at timestamp Datetime that the email was sent.
Subject string Email subject line.
recipients array Array of recipient objects.
recipient . recipient_id string Recipient id.
recipient . recipient_name string Name of recipient.
recipient . recipient_email string Email of recipient.

Click Notification

Notification Parameters
Parameter Type Description
email_id string The id of the email that was opened.
type string The type of push event.
event_at timestamp Datetime of the open.
sent_at timestamp Datetime that the email was sent.
Subject string Email subject line.
recipients array Array of recipient objects.
recipient . recipient_id string Recipient id.
recipient . recipient_name string Name of recipient.
recipient . recipient_email string Email of recipient.
href_id string Href id.
href string Link href.
href_label string Href label.

File Open Notification

Notification Parameters
Parameter Type Description
type string The type of push event.
event string The type of file event.
email_id string The id of the email that was opened.
file_id string The id of the file that was opened.
event_at timestamp Datetime of the open.
ua_family string Name of browser family the file was opened in.
ua_name string Name of the browser the file was opened in.
os_family string Name of the operating system family the file was opened on.
os_name string Name of the operating system the file was opened on.
ip string IP address of the open location.
timestamp timestamp Datetime of file open event.

File Download Notification

Notification Parameters
Parameter Type Description
type string The type of push event.
event string The type of file event.
email_id string The id of the email that was opened.
file_id string The id of the file that was opened.
event_at timestamp Datetime of the open.
ua_family string Name of browser family the file was opened in.
ua_name string Name of the browser the file was opened in.
os_family string Name of the operating system family the file was opened on.
os_name string Name of the operating system the file was opened on.
ip string IP address of the open location.
timestamp timestamp Datetime of file open event.

File Print Notification

Notification Parameters
Parameter Type Description
type string The type of push event.
event string The type of file event.
email_id string The id of the email that was opened.
file_id string The id of the file that was opened.
event_at timestamp Datetime of the open.
ua_family string Name of browser family the file was opened in.
ua_name string Name of the browser the file was opened in.
os_family string Name of the operating system family the file was opened on.
os_name string Name of the operating system the file was opened on.
ip string IP address of the open location.
timestamp timestamp Datetime of file open event.

File Exit Notification

Notification Parameters
Parameter Type Description
type string The type of push event.
event string The type of file event.
email_id string The id of the email that was opened.
file_id string The id of the file that was opened.
event_at timestamp Datetime of the open.
ua_family string Name of browser family the file was opened in.
ua_name string Name of the browser the file was opened in.
os_family string Name of the operating system family the file was opened on.
os_name string Name of the operating system the file was opened on.
ip string IP address of the open location.
timestamp timestamp Datetime of file open event.
session array Array of session events before exit event triggered.
event . event string The type of file event.
event . page integer Page number of event.
event . timeOnPage integer Total time in seconds the user was on the page.
event . timestamp timestamp Datetime of event.