Pular para o conteúdo principal
POST
/
notifications
Criar um Grupo de Notificação
curl --request POST \
  --url https://api.altostrat.io/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Alertas da Equipe de Plantão Principal",
  "schedule_id": "sch_7d1b8c0c-5121-4f27-849c-29b3a0e6201a",
  "mute": "schedule-active",
  "topics": [
    "top_9cffb446-18a5-445a-948c-e6f1d98930af",
    "top_9ba5d51f-3ada-44f2-9fb9-bf2404a29f50"
  ],
  "sites": [
    "site_a2b3c4d5-e6f7-g8h9-i0j1-k2l3m4n5o6p7",
    "site_b3c4d5e6-f7g8-h9i0-j1k2-l3m4n5o6p7q8"
  ],
  "notifiables": [
    {
      "id": "usr_5f0b6e1b-4f1e-4b4a-8b0a-0e6f0b6e1b4f",
      "channel": "whatsapp"
    }
  ]
}'
{
  "id": "ntfgrp_9b01a14c-1123-4279-88b1-3e42f9b846e1",
  "name": "Alertas da Equipe de Plantão Principal",
  "schedule_id": "sch_7d1b8c0c-5121-4f27-849c-29b3a0e6201a",
  "mute": "schedule-active",
  "notifiables": [
    {
      "id": "usr_5f0b6e1b-4f1e-4b4a-8b0a-0e6f0b6e1b4f",
      "channel": "whatsapp"
    }
  ],
  "topics": [
    "top_9cffb446-18a5-445a-948c-e6f1d98930af",
    "top_9ba5d51f-3ada-44f2-9fb9-bf2404a29f50"
  ],
  "sites": [
    "site_a2b3c4d5-e6f7-g8h9-i0j1-k2l3m4n5o6p7",
    "site_b3c4d5e6-f7g8-h9i0-j1k2-l3m4n5o6p7q8"
  ],
  "created_at": "2025-10-29T12:24:17.000Z",
  "updated_at": "2025-10-29T12:28:00.000Z"
}

Authorizations

​
Authorization
string
header
required

A Altostrat usa OAuth2 para autenticação. Tokens podem ser obtidos a partir da API de Autenticação da Altostrat.

Body

application/json

Os detalhes do grupo de notificação a ser criado.

​
name
string
required

Um nome legível por humanos para o grupo de notificação.

Maximum length: 100
Example:

"Alertas da Equipe de Plantão Principal"

​
schedule_id
string<uuid>
required

O UUID de um objeto Schedule da API Chrono, que define quando este grupo está ativo.

Example:

"sch_7d1b8c0c-5121-4f27-849c-29b3a0e6201a"

​
mute
enum<string>
required

Controla o estado de silenciamento do grupo. schedule-active silencia quando a agenda está inativa, schedule-inactive silencia quando a agenda está ativa. never e always são estados absolutos.

Opções disponíveis:
schedule-active,
schedule-inactive,
never,
always
Example:

"schedule-active"

​
topics
string<uuid>[]
required

Um array de UUIDs de Tópicos que este grupo assina.

Maximum length: 20
Example:
[
  "top_9cffb446-18a5-445a-948c-e6f1d98930af",
  "top_9ba5d51f-3ada-44f2-9fb9-bf2404a29f50"
]
​
sites
string<uuid>[]
required

Um array de UUIDs de Sites para os quais este grupo receberá notificações.

Maximum length: 800
Example:
[
  "site_a2b3c4d5-e6f7-g8h9-i0j1-k2l3m4n5o6p7",
  "site_b3c4d5e6-f7g8-h9i0-j1k2-l3m4n5o6p7q8"
]
​
notifiables
object[]
required

Um array de destinatários e seus canais de notificação preferenciais.

Maximum length: 200

Response

Grupo de notificação criado com sucesso.

​
id
string<uuid>

O identificador único para o grupo de notificação.

Example:

"ntfgrp_9b01a14c-1123-4279-88b1-3e42f9b846e1"

​
name
string

Um nome legível por humanos para o grupo de notificação.

Example:

"Alertas da Equipe de Plantão Principal"

​
schedule_id
string<uuid>

O UUID de um objeto Schedule da API Chrono, que define quando este grupo está ativo.

Example:

"sch_7d1b8c0c-5121-4f27-849c-29b3a0e6201a"

​
mute
enum<string>

Controla o estado de silenciamento do grupo. schedule-active silencia quando a agenda está inativa, schedule-inactive silencia quando a agenda está ativa. never e always são estados absolutos.

Opções disponíveis:
schedule-active,
schedule-inactive,
never,
always
Example:

"schedule-active"

​
notifiables
object[]

Um array de destinatários e seus canais de notificação designados.

​
topics
string<uuid>[]

Um array de UUIDs de Tópicos que este grupo assina.

Example:
[
  "top_9cffb446-18a5-445a-948c-e6f1d98930af",
  "top_9ba5d51f-3ada-44f2-9fb9-bf2404a29f50"
]
​
sites
string<uuid>[]

Um array de UUIDs de Sites para os quais este grupo receberá notificações.

Example:
[
  "site_a2b3c4d5-e6f7-g8h9-i0j1-k2l3m4n5o6p7",
  "site_b3c4d5e6-f7g8-h9i0-j1k2-l3m4n5o6p7q8"
]
​
created_at
string<date-time>

O timestamp de quando o grupo de notificação foi criado.

Example:

"2025-10-29T12:24:17.000Z"

​
updated_at
string<date-time>

O timestamp da última atualização do grupo de notificação.

Example:

"2025-10-29T12:28:00.000Z"