API pour déclencher la notification manuellement

Noeud final

POST /api/events/settings/alertingChannels/notify/{id}

Cas d'utilisation

Modifier en ligne

Après avoir tenté de résoudre un problème (manuellement ou par automatisation), vous devez en informer les parties prenantes concernées.
Cette fonctionnalité API permet aux utilisateurs de déclencher manuellement un canal d'alerte dans le cadre d'un événement ou d'un incident.

Contenu de la demande

Modifier en ligne

Reportez-vous à l'exemple de requête suivant :

{
    "eventId": "eventIdToTriggerAlertFor",
    "customPayloadFields": [
        {
            "type": "staticString",
            "key": "hello",
            "value": "world"
        },
        {
            "type": "staticString",
            "key": "alert",
            "value": "payload"
        }
    ]
}

Droits

Modifier en ligne

Vous devez disposer des canInvokeAlertChannel droits d'accès nécessaires pour utiliser le site API.

Détails de la charge utile

Modifier en ligne

eventId (chaîne, obligatoire) : L'identifiant de l'événement associé à l'alerte.
customPayloadFields (tableau, facultatif) : Une liste de paires clé-valeur à inclure dans la charge utile de l'alerte.
- Chaque objet du tableau contient :
- type: Spécifie le type de champ de données utiles (par exemple, staticString ).
- key: Le nom de la clé.
- value: La valeur correspondante.

Réponse prévue

Modifier en ligne

Succès (200 OK) : Le canal d'alerte a été déclenché avec succès.
Erreur (400 Bad Request) : Invalid request payload.
Erreur (404 Not Found) : L'ID du canal d'alerte n'existe pas.
Erreur (500 Internal Server Error) : Erreur inattendue du serveur.

Remarques supplémentaires

Modifier en ligne

La section customPayloadFields est facultative.
Cette page API vient compléter la page existante PUT /api/events/settings/alertingChannels/{id}API, qui permet de tester les canaux d'alerte.
Assurez-vous que l'identifiant du canal d'alerte est valide avant de faire une demande.