Webhook sortant

Un OutgoingWebhook représente la configuration d'un point de terminaison externe vers lequel les événements d'automatisation sont envoyés. Le terme « sortant » désigne les événements quittant la plateforme Portant à destination d'une cible externe.

Pour plus de détails sur les événements envoyés par Portant, consultez Écouter les événements de Portant via des webhooks.

Champs

Champ	Type	Description
id	String	L'identifiant de la configuration du webhook sortant.
webhookUrl	String	L'adresse du webhook vers laquelle les événements seront envoyés en POST.

Exemple

{
    "id": "owc_XY1Ys4gqrpX8cp",
    "webhookUrl": "https://webhook.site/d22c56ab-40ac-4f9a-93ef-02520235c0da"
},

Points de terminaison

Récupérer un webhook sortant

GET /workflows/<wkf_id>/outgoing-webhooks/

Récupère la configuration du webhook sortant pour un workflow spécifique.

Réponses

Statut	Corps
200 OK	OutgoingWebhook
403 Unauthorised	Error

Créer un webhook sortant

POST /workflows/<wkf_id>/outgoing-webhooks/

Crée la configuration du webhook sortant pour un workflow spécifique.

Requête

Le corps doit contenir un seul champ webhookUrl avec l'URL à laquelle vous souhaitez recevoir les événements.

{
    webhookUrl: "https://..."
}

Réponses

Statut	Corps
201 Created	OutgoingWebhook
400 Bad Request	Error
403 Unauthorised	Error

Mettre à jour un webhook sortant

PATCH /workflows/<wkf_id>/outgoing-webhooks/

Met à jour la configuration du webhook sortant pour un workflow spécifique.

Requête

Le corps doit contenir un seul champ webhookUrl avec l'URL à laquelle vous souhaitez recevoir les événements.

{
    webhookUrl: "https://..."
}

Réponses

Statut	Corps
200 OK	OutgoingWebhook
400 Bad Request	Error
403 Unauthorised	Error