Push Notification

The Push node enables you to send rich and interactive notifications to mobile and web apps that use Webex Connect SDKs.

83

Push Node

Prerequisites

  1. An App Asset created on Webex Connect.
  2. Webex Connect's SDK integrated within your app, with appropriate App ID and Client Key, corresponding to the App, asset embedded within the app.

📘

Note:

The app should have at least one registered user, whose User-ID or Device-ID can be used as a destination.

1031

Node Window

Node Configuration

All the parameters and input fields that you need to define within the node window are explained below.

Destination Type

There are different types of identifiers supported in Webex Connect, namely:

  • Customer-ID is a master ID that is linked to all different channel-specific user IDs of a user within the customer profile. Webex Connect's customer profile is used to store multiple channel identifiers and customer communication preferences for various customers. It is useful in cross channel communication. For e.g: You want to send an exclusive promo code to a user’s app because of previous positive feedback that they have given via Messenger. If you have the customer profile configured with details of both Facebook Messenger PSID and user id linked with the same customer ID, you can use the Customer-ID of the user since it will remain constant across both the channels.
  • User-ID is the identifier specific to Push and In-App channels. This is generally created when a user registers on your mobile/web app. It is stored in the application profile.
  • AndroidPushId is the identifier for the Android application
  • iOSPushId is the identifier for the iOS application
  • ChromePushId is the identifier for the Chrome application
  • FirefoxPushId is the identifier for the Firefox application
  • SafariPushId is the identifier for the Safari application
  • Topic is used to broadcast notifications that come under a particular section of interest. Any user who subscribes to a topic starts receiving notifications published to that topic.

📘

Note

The destination type Topic is not visible in the list, if the Topic Messaging option is disabled for your tenant.

  • Segment comes into picture when you want to target users that have subscribed to a specific combination of topics. You can create a segment containing the desired combination of topics and publish notifications to that segment.

📘

The destination type Segment is not visible in the list, if the Segment Messaging option is disabled for your tenant

  • HMSPushId is the identifier for the HMS application

Destination

This field contains the destination value corresponding to the selected Destination Type. The value can be static or dynamic. For E.g: If the destination type is Customer-ID, the Destination can be kept dynamic by declaring it as $(customerID).

Message Configuration

This section explains the elements used to orchestrate the notification:

Notification Title

Android

These are Android-specific configurations.

  • Notification Body

  • Notification Action: There are five types of actions that can be executed when a user taps on the notification:

    1. OPEN_URL would open the respective link in your browser.

    2. OPENWEBVIEW launches a web view inside your app.

    3. DEEPLINK will take you to destination defined in the link.

    4. OPEN_HTML renders the HTML payload within the app.

    5. OPEN_APP simply opens the app corresponding to the notification

  • Sound File: To play a certain sound when a device receives the notification, you can provide the URL of the sound file in this field.

  • Collapse key: This parameter is used to hide older notifications when a new notification with the same collapse key is received on the device. It's useful in cases where you need to update the user about an ongoing process. For E.g: To update the user about the status of parcel delivery, you might want to send an initial notification stating the scheduled date/time, followed by subsequent status updates like out-for-delivery, delivered. etc. All these notifications can share the same collapse key so that only the current status is visible to the user.

  • Time to live: The period of time for which a notification would reside in the notification tray.

  • Delay while idle: In-case when a notification is received, the device is in idle state, you can choose to wait for the user to be active before you display the notification on the device.

  • Priority: You can define the priority of a notification by assigning an integer from ranging 1 to 5, 5 being the highest.

  • Image URL: Used to send images in the notification.

  • Notification Icon

  • Notification channel ID: To target devices that run on Android Oreo or above, it's mandatory to assign a channel ID to each notification.

iOS

These are iOS specific configurations.

  • Attachment Type

  • Attachment URL

  • Collapse ID

  • Notification Body

  • Notification Action

    1. OPEN_URL

    2. OPENWEBVIEW

    3. DEEPLINK

    4. OPEN_HTML

    5. OPEN_APP

  • Sound File

  • Badge

  • Silent Push

  • Time to live

Web Push

These are Web-specific configurations.
For web push, you first need to select all the browsers to be targeted.

  • Notification Body
  • Notification title
  • Time to live
  • On-click URL

Interactions

  • OS - the operating system for the interactions
  • Push Reference - unique value to make interaction result available as a trigger
  • Interactions - single button or two buttons
  • Category - the available category of interactions
    • Single button - Dismiss
    • Single button - Subscribe
    • Single button - Unsubscribe
    • Single button - Share
    • Single button - Open
    • Two button - Subscribe or Unsubscribe
    • Two button - Share or Cancel
    • Two button - Like or Share
    • Two button - Yes or No
    • Two button - Accept or Cancel
    • Two button - Shopnow or Cancel
    • Two button - Later or Now
    • Two button - Play now or PlayLater
    • Two button - Ok or Learn More
    • Two button - Buy Now or Buy Later

Extra Parameters

Along with the message, you can send additional information like some user-specific property, or any custom parameter that is required to display the message in a certain fashion within the app. This information can be sent in the form of extra parameters.

Correlation ID

You can assign a unique ID of your choice to each Push message. This ID is returned to the platform with the delivery report and can be used to identify the message.

Callback Data

In case there is additional data to be sent along with the delivery reports to the URL, you must specify that here.

Validations forCallback Data & Correlation ID:

  1. Callback Data, Correlation Id fields are optional for all the channels. Send node can be saved without providing these fields.
  2. All characters, Alphabets, Numbers, and special characters are accepted.
  3. Variables can be added.
  4. Hard coded values are accepted.
  5. On Platform side, there is no Max or Min length validation for these fields.

Notify URL

You can choose to notify a URL with the delivery report for the Push message. This field accepts only a valid URL or a variable. If an invalid URL is passed in API request or via a variable, then such request will not be considered eligible for retries.

Validations for Notify URL:

  1. It is an optional field optional for all the channels. Send node can be saved without providing these fields.
  2. Notify URL should be filled with proper URL format. Otherwise, error message ‘Invalid URL, field accepts only valid URL or variable’ will be displayed.
  3. When space is provided in front of the URL, Invalid URL, field accepts only valid URL or variable’ will be displayed.
  4. When space is provided at the end of the URL, space gets trimmed and ignored and DRs are received to the URL.
  5. No Max length validation.
  6. Variables can be added to this field.

Advanced Options

Wait For

The life-cycle of push notification has three stages. You can wait for a callback at any of the stages before proceeding further in the flow by selecting any one of the following:

  1. Gateway Submit: The first stage where the configured message along with the destination is submitted to the gateway for delivery.

  2. Delivery Report: The second stage, in which the message is delivered to the targeted device.

  3. Read Report: The last stage is when the target user actually reads the message.

Expiry

Time in seconds or UTC, after which node session will Webex Connect and the flow would proceed to the next node.

Node Outcomes

  • onsuccess: Node executed successfully.
  • onsubmit: Submitted to a gateway.
  • ondrsuccess: Received DR for the transaction.
  • Onread: Received RR for the transaction.
  • onpolicyfail:
  • ondrfail: Failed to receive DR
  • onerror:
  • Ontimeout: Session Webex Connect