JS API

• Documentation
• /
• JS API

onReady

A callback function to tell you when the PushAlert JS API is ready. This is a new endpoint and has been published for all customers, however, some may still have the old integration script cached in their browsers. If you get an error using this function, please head to Settings > Website in your PushAlert dashboard and click on Submit, this will force an update to the JS API for your account.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['onReady', onPAReady]);

    function onPAReady() {
        console.log(PushAlertCo.subs_id); //if empty then user is not subscribed

        //YOUR CODE
    }
</script>

onSuccess/onFailure

You can add your callback function when user successfully subscribes or fails to subscribe. Gives you the subscription ID of current subscriber.

Callback Parameters

onSuccess

onFailure

Example

onSuccess

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['onSuccess', callbackOnSuccess]);

    function callbackOnSuccess(result) {
        console.log(result.subscriber_id); //will output the user's subscriberId
        console.log(result.alreadySubscribed); // False means user just Subscribed

        //YOUR CODE
    }
</script>

onFailure

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['onFailure', callbackOnFailure]);

    function callbackOnFailure(result) {
        console.log(result.status); //-1 - blocked, 0 - canceled or 1 - unsubscribed

        //YOUR CODE
    }
</script>

getSubsInfo

Get subscription status of user and unique subscriber identifier (subs_id).

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['onReady', onPAReady]);

    function onPAReady() {
        PushAlertCo.getSubsInfo(); //You can call this method to get the subscription status of the subscriber
    }
</script>

Output

{status: "subscribed", subs_id: "dkoVhWiR+A645Q/cbFoOAQ=="}

disableAutoInit

Consider that you don't want the opt-in to be displayed automatically, you can use the following code. However, once auto initialization is disabled, you would have to call the init method to bring up the opt-in prompt.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['disableAutoInit', true]);
</script>

Bring up subscription opt-in manually

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['onReady', onPAReady]);

    function onPAReady() {
        PushAlertCo.init(); //You can call this method to request subscription box manually
    }
</script>

triggerMe

Trigger the selected opt-in manually.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['onReady', onPAReady]);

    function onPAReady() {
        PushAlertCo.triggerMe(false); //You can call this method to request the opt-in manually
    }
</script>

forceSubscribe

Brings up the subscription opt-in, even if previously declined. Circumvents the opt-in settings, and shows the native browser opt-in directly. If you want to show the 2-step opt-in (selected in Settings > Opt-in Box) use triggerMe function. Can be used to create Subscribe and Unblock buttons, check examples below.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['onReady', onPAReady]);

    function onPAReady() {
        PushAlertCo.forceSubscribe(); //This will bring up the subscription opt-in, if it is not blocked. If blocked, it will show steps to unblock notifications.
    }
</script>

Subscribe Button

<button onclick='PushAlertCo.forceSubscribe()'>Subscribe</button>

Unblock Button

<button onclick='PushAlertCo.forceSubscribe()'>Unblock</button>

unsubscribe

For opting-out of Push Notifications. User won't receive any notifications if successfully unsubscribed. Can also be used to create separate Unsubscribe button on website.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['onReady', onPAReady]);

    function onPAReady() {
        PushAlertCo.unsubscribe();
    }
</script>

Unsubscribe Button

<button onclick="PushAlertCo.unsubscribe()">Unsubscribe</button>

pa_localized_str

For multi-language websites and for per-page customization of PushAlert subscription opt-in prompts. This can be used to customize the text shown on opt-in prompts. If any fields are left, the default value would be picked from the database. You can generate custom text for prompts with the help of Localized String Generator, for more details see Localization.

subs_id

To get subscription ID of current user. This can be used to associate subscriber to a particular segment or send notification to that individual.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['onReady', onPAReady]);

    function onPAReady() {
        console.log(PushAlertCo.subs_id); //if empty then user is not subscribed

        //YOUR CODE
    }
</script>

addAttributes

To add custom attributes to a subscriber. This function will do nothing if the user is not subscribed, else mentioned attributes will be added to the subscriber. These attributes can be used in personalizing notifications and for targeting particular sets of subscribers. Maximum key length is 32 characters and value length is 128 characters.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['addAttributes', {"user_id":10, "name":"John"}]); //add attributes in form of key-value pair
</script>

subscribeToSegment

Brings up the subscription opt-in box and if a segment ID is provided, subscribers are automatically added to the mentioned segment.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['subscribeToSegment', 3383]); //You can get segment ID from dashboard or via REST API
</script>

addToSegment

To add a user to a particular segment. This function will do nothing if the user is not subscribed, else they will be automatically added to mentioned segment. Additionally you can mention a callback function. To bring up a subscription prompt for a specific segment, you can use the above function - subscribeToSegment

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['addToSegment', 993, callbackFunction]); //You can get segment ID from dashboard or via REST API

    function callbackFunction(result){
        console.log(result.success) // True or False
        //Your Code
    }
</script>

removeFromSegment

To remove a user from a particular segment. This function will do nothing if the user is not subscribed, else they will be automatically removed from the mentioned segment. Additionally you can mention a callback function.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['removeFromSegment', 993, callbackFunction]); //You can get segment ID from dashboard or via REST API

    function callbackFunction(result){
        console.log(result.success) // True or False
        //Your Code
    }
</script>

trackEvent

To send automated notification when a subscriber triggers an event. Add the following script on the page where you want to track an event. You can track multiple events on the same page.

Request Parameters

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['trackEvent', 'video', 'play', 'winter collection', '51']); //trackEvent(eventCategory, eventAction, eventLabel, eventValue)
</script>

abandonedCart

Use this function to schedule/update a notification when a cart is abandoned on your eCommerce store or delete it when the order is completed/cart is cleared.

You can use two parameters to personalize notifications - first_name and total_items. You can choose to include either one or both of them. Where 'first_name' is the first or full name of the customer, while 'total_number' is the number of items in cart.
For e.g. {'first_name':'Alex','total_items':2}

Schedule an abandoned cart notification or update an existing notification when the cart is changed.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['abandonedCart', 'add-to-cart',{'first_name':'Alex','total_items':2}]);
</script>

Delete an abandoned cart notification on order completion or when all products are removed from cart.

Example

<script>
    (pushalertbyiw = window.pushalertbyiw || []).push(['abandonedCart', 'completed']);
</script>