notify
Notificar
Publica uma mensagem num canal, ou avisa pessoas de uma linha.
- Kind:
step - Key:
notify - Categoria:
action - Envelope: mapa (um objeto JSON em
config)
Campos
| Chave | Tipo | Obrigatório | Omissão | Descrição | Referência |
|---|---|---|---|---|---|
scopeType | enumeration | não | "channel" | Que tipo de alvo recebe o aviso: channel (um canal de mensagens) ou user (pessoas). | - |
scopeId | uuid | não | "" | O canal de mensagens onde a mensagem é publicada (o scopeId de Message, que com scopeType: channel é um canal). Vazio com scopeType: user. | canal (uuid) |
from | map | não | - | Quem é avisado com scopeType: user: uma coluna de pessoas da linha do gatilho, ou pessoas fixas. | - |
content | string | não | "" | O corpo da mensagem. Aceita tokens {{record.x}}/{{vars.y}}, resolvidos ao publicar. | expressões {{record.coluna}} |
type | enumeration | não | "chat" | Dica de render da mensagem: chat (como um humano) ou system (aviso do sistema). | - |
from
| Chave | Tipo | Obrigatório | Omissão | Descrição | Referência |
|---|---|---|---|---|---|
userColumn | string | não | - | O nome da coluna de pessoas de onde saem os destinatários. | coluna (nome) |
users | list de uuid | não | - | Ids de pessoas fixas, da organização de origem. | - |
Exemplo JSON
{
"scopeType": "channel",
"scopeId": "nome-da-channel",
"content": "",
"type": "chat"
}
Gerado de definitions.json versão 17f3e0bc59d9. Esta página nasce no build: não se edita à mão.