API para acionar a notificação manualmente
Terminal
POST /api/events/settings/alertingChannels/notify/{id}
Casos de uso
- Depois de tentar resolver um problema (manualmente ou por meio de automação), você precisa notificar as partes interessadas relevantes.
- Esta configuração de canal de alerta ( API ) permite que os usuários acionem manualmente um canal de alerta dentro de um evento ou incidente.
Carga útil da solicitação
Consulte o exemplo de carga útil de solicitação a seguir:
{
"eventId": "eventIdToTriggerAlertFor",
"customPayloadFields": [
{
"type": "staticString",
"key": "hello",
"value": "world"
},
{
"type": "staticString",
"key": "alert",
"value": "payload"
}
]
}
Permissões
Você precisa de canInvokeAlertChannel permissão para usar o API.
Detalhes da carga útil
eventId(string, obrigatório): A ID do evento associado ao alerta.customPayloadFields(matriz, opcional): Uma lista de pares de valores-chave a serem incluídos na carga útil do alerta.- Cada objeto da matriz contém:
type: Especifica o tipo de campo de carga útil (por exemplo,staticString).key: O nome da chave.value: O valor correspondente.
Resposta esperada
- Sucesso (200 OK) : O canal de alerta foi acionado com êxito.
- Erro (400 Bad Request) : Carga útil de solicitação inválida.
- Erro (404 não encontrado) : A ID do canal de alerta não existe.
- Erro (500 Internal Server Error) : Erro inesperado do servidor.
Notas adicionais
- A seção
customPayloadFieldsé opcional. - Este API complementa o
PUT /api/events/settings/alertingChannels/{id}API já existente para testar canais de alerta. - Certifique-se de que a ID do canal de alerta seja válida antes de fazer uma solicitação.