Base URL of this API is https://api.engagespot.com/v3/

This API can be authenticated in three ways.

1. Authenticate using API-KEY and API-SECRET (For your backend)

This mode is required when you want to authenticate as your Engagespot app and send a notification to one or more recipients. The credentials can be found in your Engagespot console.

2. Authenticate using API-KEY and USER-ID (For Inbox)

This mode should be used when you want to authenticate as your user and want to perform actions on behalf of them. For example, reading the notification inbox of a user, deleting a notification from a user's inbox etc.

3. Authenticate using Bearer Token (For Inbox - Secure Mode)

This mode is for the same purpose as above. But uses a JWT Token in Auth Bearer header for increased security.

These authentication parameters should be passed via headers.

Engagespot uses HTTP response codes to indicate the success or failure of an API request.

• Codes in the 2xx range indicate success.
• Codes in the 4xx range indicate an error with your request.
• Codes in the 5xx range indicate an error with Engagespot server. Please contact support if you encounter this.

Handling Errors

Along with the HTTP Response, the body will contain the details of error. Usually, the format is

Authentication Errors

This will be the format of 401 errors, usually represents an issue with auth credentials.

{
  "status": "error",
  "message": "No auth params (or combination of params) were found in the request"
}

Validation Errors

This will be the format of 400 errors, usually represents an issue with the request.

{
  "status": "error",
  "message": [
    "notification must be an object"
  ]
}

Notification is the entity that represents an information that you need to send to a recipient. Engagespot provides API to send, read and manage notifications. Please note that, the permission levels required for each API might be different. For example, to send notification, you will need to authenticate as an app, with your secret Key. But to read and manage notifications on behalf of your users, you should authenticate as the User.

Manage categories.