RoomScope

Última atualização

Alertas

Regras de alerta que disparam em eventos de LIVE (webhook, e-mail, no app, Telegram).

Toda operação se autentica com uma chave de API (Authorization: Bearer <key>) e os erros usam o envelope comum descrito em Erros. Gerado a partir do documento OpenAPI da API.

Listar entregas de alertas

GET/v1/alerts/deliveries

Uma linha por regra, canal e evento: delivered, failed (com detail e as attempts feitas) ou capped (um limite do plano, como o limite mensal de webhooks, a descartou), mais recentes primeiro.

Escopowebhook:manageCréditosGrátis

Parâmetros de query

Parâmetros de query · GET /v1/alerts/deliveries
NameTypeDescription
ruleIdOptional
stringSomente esta regra (UUID).
statusOptional
"delivered" | "failed" | "capped"Somente este resultado.
sinceOptional
stringHorário ISO 8601; somente linhas mais novas.
limitOptional
integerLinhas a retornar. Faixa 1–200.
Default: 50

Requisição

curl "https://api.next.toktokdata.live/v1/alerts/deliveries" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Resposta

200 OK
{  "items": [    {      "id": "5a7e0b0c-2d55-5f11-8b0e-0d0a3c5e6f70",      "source": "alert",      "ruleId": "7d01133d-6ecb-5101-a9c0-e23e4755bad9",      "ruleName": "Envelopes from Linh",      "channelType": "webhook",      "eventType": "envelope",      "status": "failed",      "attempts": 4,      "detail": "retry exhausted: webhook HTTP 503",      "isTest": false,      "createdAt": "2026-11-06T09:58:13.410Z"    },    {      "id": "a3d9c6e1-4b2f-5c8e-9a71-2e5b8d0f4c13",      "source": "alert",      "ruleId": "7d01133d-6ecb-5101-a9c0-e23e4755bad9",      "ruleName": "Envelopes from Linh",      "channelType": "in_app",      "eventType": "envelope",      "status": "delivered",      "attempts": 1,      "detail": null,      "isTest": false,      "createdAt": "2026-11-06T09:58:12.512Z"    }  ],  "observedAt": "2026-11-06T09:58:13.410Z",  "provenance": {    "observedAt": "2026-11-06T10:00:00.000Z",    "freshness": "near_realtime",    "source": "workspace_alert_history",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "alert-history-v1",    "window": null  }}

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeite Retry-After.

Listar disparos de alertas

GET/v1/alerts/fires

Cada vez que uma regra correspondeu a um evento, mais recentes primeiro, tenha ou não um canal entregado (compare com as entregas).

Escopowebhook:manageCréditosGrátis

Parâmetros de query

Parâmetros de query · GET /v1/alerts/fires
NameTypeDescription
ruleIdOptional
stringSomente esta regra (UUID).
sinceOptional
stringHorário ISO 8601; somente linhas mais novas.
limitOptional
integerLinhas a retornar. Faixa 1–200.
Default: 50

Requisição

curl "https://api.next.toktokdata.live/v1/alerts/fires" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Resposta

200 OK
{  "items": [    {      "id": "1c3b5e86-0f43-5a3e-9d3c-5f6a1f0e7b21",      "ruleId": "7d01133d-6ecb-5101-a9c0-e23e4755bad9",      "ruleName": "Envelopes from Linh",      "eventType": "envelope",      "roomId": "7568123456789012345",      "creatorUniqueId": "linh.live",      "channelCount": 2,      "isTest": false,      "firedAt": "2026-11-06T09:58:12.104Z"    }  ],  "observedAt": "2026-11-06T09:58:12.104Z",  "provenance": {    "observedAt": "2026-11-06T10:00:00.000Z",    "freshness": "near_realtime",    "source": "workspace_alert_history",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "alert-history-v1",    "window": null  }}

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeite Retry-After.

Listar regras de alerta

GET/v1/alerts/rules

Todas as regras do espaço de trabalho com seus canais. Os segredos de assinatura nunca são retornados de novo.

Escopowebhook:manageCréditosGrátis

Requisição

curl "https://api.next.toktokdata.live/v1/alerts/rules" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Resposta

200 OK
{  "rules": [    {      "id": "7d01133d-6ecb-5101-a9c0-e23e4755bad9",      "name": "Envelopes from Linh",      "creatorUniqueId": "linh.live",      "scope": "creator",      "gifterKey": null,      "region": null,      "eventTypes": [        "envelope"      ],      "minScore": null,      "minRate": null,      "minDiamondCount": 100,      "minFollowerMilestone": null,      "goodyBagAllowAllViewers": null,      "goodyBagMaxRequiredLevel": null,      "enabled": true,      "createdAt": "2026-11-01T10:51:45.582Z",      "updatedAt": "2026-11-01T10:51:45.582Z",      "channels": [        {          "id": "3d0d4dc5-6993-55ab-a1cd-ffbe7db95507",          "channelType": "in_app",          "target": null,          "enabled": true,          "hasSigningSecret": false        }      ]    }  ],  "provenance": {    "observedAt": "2026-11-01T10:00:00.000Z",    "freshness": "near_realtime",    "source": "workspace_alert_rules",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "alert-rules-v1",    "window": null  }}

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeite Retry-After.

Criar uma regra de alerta

POST/v1/alerts/rules

Uma regra monitora um criador (ou uma região inteira) em busca de tipos de evento e entrega aos seus canais. O segredo de assinatura de um canal de webhook é retornado uma única vez, em webhookSecrets.

Escopowebhook:manageCréditosGrátis

Corpo da requisição

Corpo da requisição · POST /v1/alerts/rules
NameTypeDescription
nameRequired
stringExibido nas notificações.
creatorUniqueIdOptional
string | nullMonitora um criador; omita para monitorar toda a região.
scopeOptional
"creator" | "any" | "watchlist" | "gifter_watchlist"O que a regra observa: o criador fixado, todas as salas (opcionalmente uma região), os criadores da watchlist do workspace ou a watchlist de gifters (uma regra por workspace). O padrão é creator quando há creatorUniqueId; caso contrário, any.
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[]Eventos LIVE (gift, envelope, goodyBag, live_start, live_end) e verificações de host a cada hora para o criador ou a watchlist da regra: host_quiet (sem LIVE por 3 dias), league_change, diamond_target (um dia do ranking atingiu minDiamondCount) e follower_milestone (passou de um múltiplo de minFollowerMilestone).
minDiamondCountOptional
integer | nullIgnora eventos que valem menos diamantes que isso.
minFollowerMilestoneOptional
integer | nullPasso de seguidores para follower_milestone (ex.: 10000).
enabledOptional
boolean
Default: true
channelsOptional
object[]

Requisição

curl -X POST "https://api.next.toktokdata.live/v1/alerts/rules" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY" \  -H "Content-Type: application/json" \  -d '{"name":"Envelopes from Linh","creatorUniqueId":"linh.live","eventTypes":["envelope"],"minDiamondCount":100,"channels":[{"channelType":"webhook","target":"https://example.com/hooks/roomscope"}]}'

Resposta

201 Created
{  "rule": {    "id": "7d01133d-6ecb-5101-a9c0-e23e4755bad9",    "name": "Envelopes from Linh",    "creatorUniqueId": "linh.live",    "scope": "creator",    "gifterKey": null,    "region": null,    "eventTypes": [      "envelope"    ],    "minScore": null,    "minRate": null,    "minDiamondCount": 100,    "minFollowerMilestone": null,    "goodyBagAllowAllViewers": null,    "goodyBagMaxRequiredLevel": null,    "enabled": true,    "createdAt": "2026-11-01T10:51:45.582Z",    "updatedAt": "2026-11-01T10:51:45.582Z",    "channels": [      {        "id": "3d0d4dc5-6993-55ab-a1cd-ffbe7db95507",        "channelType": "in_app",        "target": null,        "enabled": true,        "hasSigningSecret": false      }    ]  },  "webhookSecrets": []}

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeite Retry-After.

Atualizar uma regra de alerta

PATCH/v1/alerts/rules/{rule_id}

Envie apenas os campos a alterar; channels substitui a lista inteira.

Escopowebhook:manageCréditosGrátis

Parâmetros de caminho

Parâmetros de caminho · PATCH /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringID da regra de alerta (UUID).

Corpo da requisição

Corpo da requisição · PATCH /v1/alerts/rules/{rule_id}
NameTypeDescription
nameOptional
stringExibido nas notificações.
creatorUniqueIdOptional
string | nullMonitora um criador; omita para monitorar toda a região.
scopeOptional
"creator" | "any" | "watchlist" | "gifter_watchlist"O que a regra observa: o criador fixado, todas as salas (opcionalmente uma região), os criadores da watchlist do workspace ou a watchlist de gifters (uma regra por workspace). O padrão é creator quando há creatorUniqueId; caso contrário, any.
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[]Eventos LIVE (gift, envelope, goodyBag, live_start, live_end) e verificações de host a cada hora para o criador ou a watchlist da regra: host_quiet (sem LIVE por 3 dias), league_change, diamond_target (um dia do ranking atingiu minDiamondCount) e follower_milestone (passou de um múltiplo de minFollowerMilestone).
minDiamondCountOptional
integer | nullIgnora eventos que valem menos diamantes que isso.
minFollowerMilestoneOptional
integer | nullPasso de seguidores para follower_milestone (ex.: 10000).
enabledOptional
boolean
Default: true
channelsOptional
object[]

Requisição

curl -X PATCH "https://api.next.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY" \  -H "Content-Type: application/json" \  -d '{"enabled":false}'

Resposta

200 OK
{  "id": "7d01133d-6ecb-5101-a9c0-e23e4755bad9",  "name": "Envelopes from Linh",  "creatorUniqueId": "linh.live",  "scope": "creator",  "gifterKey": null,  "region": null,  "eventTypes": [    "envelope"  ],  "minScore": null,  "minRate": null,  "minDiamondCount": 100,  "minFollowerMilestone": null,  "goodyBagAllowAllViewers": null,  "goodyBagMaxRequiredLevel": null,  "enabled": true,  "createdAt": "2026-11-01T10:51:45.582Z",  "updatedAt": "2026-11-01T10:51:45.582Z",  "channels": [    {      "id": "3d0d4dc5-6993-55ab-a1cd-ffbe7db95507",      "channelType": "in_app",      "target": null,      "enabled": true,      "hasSigningSecret": false    }  ]}

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeite Retry-After.

Excluir uma regra de alerta

DELETE/v1/alerts/rules/{rule_id}

Exclui a regra e seus canais. Não retorna corpo.

Escopowebhook:manageCréditosGrátis

Parâmetros de caminho

Parâmetros de caminho · DELETE /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringID da regra de alerta (UUID).

Requisição

curl -X DELETE "https://api.next.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Resposta

204 sem corpo.

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeite Retry-After.

Enviar uma notificação de teste

POST/v1/alerts/rules/{rule_id}/test

Entrega agora um evento de teste a cada canal ativo da regra e retorna como foi cada um em results (delivered, failed ou capped, com detail). Disparos e entregas de teste são registrados com isTest: true.

Escopowebhook:manageCréditosGrátis

Parâmetros de caminho

Parâmetros de caminho · POST /v1/alerts/rules/{rule_id}/test
NameTypeDescription
rule_idRequired
stringID da regra de alerta (UUID).

Requisição

curl -X POST "https://api.next.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9/test" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Resposta

200 OK
{  "enqueued": 2,  "results": [    {      "channelId": "3d0d4dc5-6993-55ab-a1cd-ffbe7db95507",      "channelType": "in_app",      "status": "delivered",      "detail": null    },    {      "channelId": "9e1f2a3b-4c5d-5e6f-8a7b-0c1d2e3f4a5b",      "channelType": "discord",      "status": "failed",      "detail": "discord HTTP 404"    }  ]}

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeite Retry-After.

Atividade de alertas nas últimas 24 horas

GET/v1/alerts/stats

Regras ativas, disparos e entregas por resultado nas últimas 24 horas (sem testes).

Escopowebhook:manageCréditosGrátis

Requisição

curl "https://api.next.toktokdata.live/v1/alerts/stats" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Resposta

200 OK
{  "rulesActive": 3,  "fired24h": 41,  "delivered24h": 78,  "failed24h": 2,  "capped24h": 0,  "provenance": {    "observedAt": "2026-11-06T10:00:00.000Z",    "freshness": "near_realtime",    "source": "workspace_alert_history",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "alert-history-v1",    "window": {      "from": "2026-11-05T10:00:00.000Z",      "to": "2026-11-06T10:00:00.000Z",      "label": "24h"    }  }}

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeite Retry-After.
Esta página foi útil?