API Reference

Learn how to access UNLOQ end points

POST /notifications

Schedules a new in-app notification for sending

POST https://api.unloq.io/v1/notifications
Headers:
   - X-Api-Key: {your application API Key}
   - X-Api-Secret: {your application API Secret}
Body Parameters
  • name (string) - The name of the notification request
  • type (enum, required) - The type of notification. Values are: SIMPLE, SURVEY, RADIO, CHECKBOX
  • title (string, required) - The title of the notification that will appear in the in-app notification, max 50 chars
  • content (string, required) - The actual text that will appear in the in-app notification, max 250 chars
  • level (integer) - The urgency of the notification. Defaults to 0
  • broadcast (boolean) - If set to true, it will send the notification to all the application's users
  • users (array of integer) - An array of UnloqID's that you want to send the in-app notification to
  • groups (array of integer) - An array of group id's that you want to send the in-app notification to
  • close_text (string) - The "Close" button text when used with Survey type, max 15 chars
  • submit_text (string) - The "Submit" button text when used with Survey type, max 15 chars
  • send_at (integer) - The UTC timestamp for when to schedule the notification, or the special value now for instant sending
  • radio (array of objects) - An array of radio buttons when used with Radio type, that will be sent to the in-app notification, min 2 max 10
  • checkbox (array of objects) - An array of radio buttons when used with Checkbox type, that will be sent to the in-app notification, min 2 max 10
Notes

When creating a notification with type Radio or Checkbox, the radio or checkbox fields must contain an array of objects with the following properties:

  • text (string) - The radio or checkbox button's text
  • selected (boolean) - If set to true, the radio or checkbox button will appear selected.
Result format (200 OK)
{
  "type": "api.application.notification.create",
  "result": {
    "id": "12345",
    "type": "RADIO",
    "status": "PENDING",
    "title": "BROADCAST",
    "content": "The content",
    "level": 0,
    "open_count": 0,
    "send_at": "2016-11-25T23:58:58.000Z",
    "name": "BROADCAST",
    "receivers": [
      "1",
      "2",
      "3"
    ]
  }
}

Have a question? You can always send us an email at support@unloq.io, or contact us on chat.

For security related concerns, please visit our Security page.