API Reference

Delete a channel

DELETE/api/v1/channel/manage/{channelid}

Authorization

BearerAuth

Path parameters

channelid*string (url_safe_base64)

The url safe, base64 encoded external channel id

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/channel/manage/{channelid}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer url_safe bas64"
    },
});
const data = await response.json();

Revoke selected token

DELETE/api/v1/channel/manage/{channelid}/api-token/{tokenid}

Authorization

BearerAuth

Path parameters

channelid*string (url_safe_base64)

The url safe, base64 encoded external channel id

tokenid*string

The url safe, base64 encoded API Bearer token for the selected channel

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/channel/manage/{channelid}/api-token/{tokenid}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer url_safe bas64"
    },
});
const data = await response.json();

Delete messages from channel

DELETE/api/v1/channel/{channelid}/{sequence}

Authorization

BearerAuth

Path parameters

channelid*string (url_safe_base64)

The url safe, base64 encoded external channel id

sequence*integer

The sequence number of the message of interest

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/channel/{channelid}/{sequence}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer url_safe bas64"
    },
});
const data = await response.json();

Subscribe to websocket notifications for new messages

GET/api/v1/channel/{channelid}/notify

Path parameters

channelid*string

The url safe, base64 encoded external channel id

Response

200

Subscribe to websocket notifications for new messages

Body

application/json

sequenceinteger

receivedstring (date-time)

content_typestring

payloadstring

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/channel/{channelid}/notify', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "received": "2024-09-18T21:54:18.639Z",
  "content_type": "text",
  "payload": "text"
}