alerts

Create an alert event document

This endpoint can be used to create a new alert event document. The event document will be stored in the user's Firestore database. Use this for creating event documents for "Other Alerts" in the dashboard.

POST/alerts/events

Header parameters

Body

application/json

Body

overlayMessages*array of string

type*enum

followsubscriptionraidgiftsubscriptioncheerhypetrainstarthypetrainprogressshoutoutcreate

Response

201

201

Body

application/json

eventDocument*object

Request

JavaScriptCurlPython

const response = await fetch('/alerts/events', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "overlayMessages": [
        "text"
      ],
      "type": "follow"
    }),
});
const data = await response.json();

Response

201

{
  "eventDocument": {
    "id": "text",
    "type": "follow",
    "overlayId": "text",
    "overlayMessage": "text",
    "overlayMessages": [
      "text"
    ],
    "overlayMessagesForVideos": [
      "text"
    ],
    "chatMessage": "text",
    "volume": 0,
    "sounds": [
      {
        "id": "text",
        "location": "text",
        "name": "text",
        "volume": 0,
        "videoAudioOnly": false
      }
    ],
    "sounds_order": "none",
    "ttsAlertAnnouncement": "text",
    "ttsUserMessagesEnabled": true,
    "disabled": false,
    "minSubscriptionTier": "1000",
    "ttsVoice": "text"
  }
}

Delete an alert event document

This endpoint can be used to delete an alert event document from the user's Firestore database.

DELETE/alerts/events/{id}

Path parameters

id*string

Header parameters

Response

204

204

Request

JavaScriptCurlPython

const response = await fetch('/alerts/events/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update an alert event document

This endpoint can be used to update an alert event document. The event document will be updated in the user's Firestore database.

PUT/alerts/events/{id}

Path parameters

id*string

Header parameters

Body

application/json

Body

condition*integer

overlaynullable any

overlayIdnullable string

overlayMessage*string

overlayMessages*array of string

overlayForVideosnullable any

overlayMessagesForVideosarray of string

chatMessagenullable string

volume*number

sounds*array of object

sounds_order*enum

nonerandomsequential

ttsAlertAnnouncementnullable string

ttsUserMessagesEnabledboolean

disabled*boolean

minSubscriptionTierenum

100020003000

ttsVoicenullable string

Response

201

201

Body

application/json

eventDocument*object

Request

JavaScriptCurlPython

const response = await fetch('/alerts/events/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "overlayMessage": "text",
      "overlayMessages": [
        "text"
      ],
      "volume": 0,
      "sounds": [
        {
          "id": "text",
          "location": "text",
          "name": "text",
          "volume": 0
        }
      ],
      "sounds_order": "none",
      "disabled": false
    }),
});
const data = await response.json();

Response

201

{
  "eventDocument": {
    "id": "text",
    "type": "follow",
    "overlayId": "text",
    "overlayMessage": "text",
    "overlayMessages": [
      "text"
    ],
    "overlayMessagesForVideos": [
      "text"
    ],
    "chatMessage": "text",
    "volume": 0,
    "sounds": [
      {
        "id": "text",
        "location": "text",
        "name": "text",
        "volume": 0,
        "videoAudioOnly": false
      }
    ],
    "sounds_order": "none",
    "ttsAlertAnnouncement": "text",
    "ttsUserMessagesEnabled": true,
    "disabled": false,
    "minSubscriptionTier": "1000",
    "ttsVoice": "text"
  }
}