User Guide

Last updated: Jan 17th, 2017

Introduction

This guide assumes that you have already created an Engagespot account and you have noted the required API credentials from your dashboard. If you haven't created an Engagespot account. Get one one for free by clicking the button below.

Sign Up

Installation

For Normal Websites

If you want to install Engagespot in a static/html website, follow this guide. Login to your Engagespot Dashboard. Goto Website Settings. There you will see the javascript code. You have to copy the code and paste it just above the closing body tag.

Default code example:
<script src="https://cdn.engagespot.co/EngagespotSDK.js"></script>
<script>
var Engagespot = new Engagespot({
"siteId" : 1232,
"siteKey" : "saaBkIFEH50PSFLFEJQDlMSqIBwjaPy",
"subdomain" : "mywebsite",
});
</script>

For Wordpress Websites

Installing Engagespot web push on a WordPress website is simple. You just have to download the Engagespot Web Push Notifications plugin and activate it. Then go to Engagespot menu in your WordPress dashboard and enter your API credentials.

Detailed guide on plugin installation can be found at Our Knowledgebease

For Magento

Installing Engagespot web push on a Magento website is simple. You just have to download the Engagespot Web Push Notifications extension to your Magento admin dashboard. Then go to Engagespot menu in your Magento dashboard and enter your API credentials.

REST API

Use Engagespot REST API for integrating advanced features like behaviour analytics to your account.

Authentication

Each API call should be authenticated using the header parameter API-Key. You can find your API Key from the website settings section on your Engagespot dashboard

curl -H "API-Key: <insert API Key here>" https://api.engagespot.co/2/campaigns
                                        

Send a new campaign POST

Use this API for creating and sending a new push notification campaign

API URL
https://api.engagespot.co/2/campaigns
Parameters
campaign_name string
Name of the campaign
notification JSON OBJECT
title string
Notification Title
message string
Notification Message
icon string
Notification Icon URL
url string
Notification URL
send_to string
Can be 'new_segment' or 'everyone'
list_id string
List to which notification should be sent. Don't use if you want to send notifications to all subscribers.
rules_combination string
Can be 'all' or 'any'
segment_rules JSON ARRAY
rule_type string
Rule Type.
rule_condition string
Condition of the rule
rule_value string
Rule value

Capture Events POST

Use this API for capturing user events from your website

API URL
https://api.engagespot.co/2/events
Parameters
user_hash string
User hash obtained from cookie - _webPushUserHash
action string
See allowed actions in Miscellaneous
object JSON OBJECT
id string
Unqiue identifier
name string
Name for identification

Miscellaneous

Values for rule_type

Following rule_type are currently supported

  • visited
  • added_to_cart
  • purchased

Values for rule_condition

rule_conditions for each rule_types

  • push_campaign_click
    • clicked
    • not_clicked
  • visited
    • at_least_once
    • never_visited
  • website_visit
    • for
    • not_for
  • added_to_cart
    • but_not_purchased
  • purchased
    • purchased
    • never_purchased
  • CUSTOM EVENT
    • atleast_once
    • never

Values for action

Following values for action are supported

  • visited
  • added_to_cart
  • purchased
  • ANY CUSTOM EVENT