Skip to content
API Reference/
/
Preview notification

ibl-data-manager (4.84.1-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

Get notification context data

Request

Get all context data needed for notification building including templates, channels, and platforms

Security
PlatformApiKeyAuthentication
Path
platform_keystringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/orgs/{platform_key}/notification-builder/context/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
statusstringrequired
dataobjectrequired
data.​property name*anyadditional property
Response
application/json
{
  "status": "string",
  "data": {
    "property1": null,
    "property2": null
  }
}

Preview notification

Request

Preview notification recipients and get build ID for sending

Security
PlatformApiKeyAuthentication
Path
platform_keystringrequired
Body
required
template_idstring or null(uuid)

Use a predefined template in the system

template_dataobject or null
channelsArray of integersrequired

Specify the channel ids to send notifications to.

sourcesArray of objects(NotificationSource)required

Specify the sources to send notifications to

sources[].​typestring(NotificationSourceTypeEnum)required
  • email - email
  • username - username
  • platform - platform
  • csv - csv
  • department - department
  • pathway - pathway
  • program - program
Enum"email""username""platform""csv""department""pathway""program"
sources[].​dataany or nullrequired
contextobject

Specify the context that would be available in the message text

process_onstring or null(date-time)

(ISO datetime) Specify the date and time of processing this notification. Note, notifications are sent hourly and only scheduled messages prior to the beginning of the hour would be sent

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/orgs/{platform_key}/notification-builder/preview/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    "template_data": {
      "message_title": "",
      "message_body": "string"
    },
    "channels": [
      0
    ],
    "sources": [
      {
        "type": "email",
        "data": null
      }
    ],
    "context": {
      "property1": null,
      "property2": null
    },
    "process_on": "2019-08-24T14:15:22Z"
  }'

Responses

Bodyapplication/json
statusstringrequired
build_idstring(uuid)required
countintegerrequired
warningstring or nullrequired
recipientsArray of objects(Recipient)required
recipients[].​usernamestringrequired
recipients[].​emailstring(email)required
recipients[].​statusstring
Default "pending"
Response
application/json
{
  "status": "string",
  "build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
  "count": 0,
  "warning": "string",
  "recipients": [
    { … }
  ]
}

Send notification

Request

Send notifications to all recipients in a build

Security
PlatformApiKeyAuthentication
Path
platform_keystringrequired
Body
required
build_idstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/orgs/{platform_key}/notification-builder/send/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "build_id": "string"
  }'

Responses

Bodyapplication/json
statusstringrequired
notifications_sentintegerrequired
build_idstring(uuid)required
messagestringrequired
Response
application/json
{
  "status": "string",
  "notifications_sent": 0,
  "build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
  "message": "string"
}

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com