Push Browser Notifications to Users

Lets you push browser notifications to specific users. You can use this API with Lapps and Automation, to push notifications to users for  –

  • An “Incoming SMS”
  • An “Email Received” through the email sync app
  • An “Incoming Call” with status as voice message or missed call
  • A prospect in an active lead stage who has just opened an email or visited your pricing page

Here’s an example of the notification –

browser notification api

Note: 

  • User Id is not mandatory. If you don’t pass a User Id, the notification will be sent to the user who’s access and secret keys are being passed
  • Click URL is not mandatory. If you pass a Click URL (lead details page link ideally), the user will be directed to it on clicking the notification.
  • Icon URL is not mandatory. You can pass it to display an icon on the notification.
  • The Title and Content data together cannot exceed 2KB.

If you’re receiving an error in the response, it may be that your browser notifications are blocked.

For Google Chrome  –

allow notifications

For Firefox –

enable notifications

 

API URL

POST
https://{host}/v2/Notifier.svc/Browser.Push?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
      "UserId": "3b1041fb-8374-11e7-8758-0a106ee76b21",
      "Title": "LeadSquared Signals",
      "Content": "You may want to call this lead while it remains hot! , <>, <>",
      "ClickURL": "",
      "IconURL": ""
}

JSON Properties

Parameter Description
UserId

Pass the user Id of the user you want to push the notification to.

Title

The title you want displayed on the notification.

Content

The content to display on the notification.

ClickURL

On clicking the notification, the user will be directed to this URL. This could be a link to the lead details page in LeadSquared for example.

IconURL

Use this parameter to display an icon on the notification.

Response

200 OK

Content-Type: application/json

{
    "Status": "Success",
    "Message": {
        "Message": "Message broadcasted successfully"
    }
}

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.