WebHooks dans Talend Cloud Management Console - Cloud

Guide utilisateur de Talend Cloud Management Console

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
Administration et monitoring > Gestion des projets
Administration et monitoring > Gestion des utilisateurs
Déploiement > Déploiement > Exécution de Pipelines
Déploiement > Déploiement > Exécution de Tâches
Déploiement > Ordonnancement > Ordonnancement de Tâches
EnrichPlatform
Talend Management Console
Les WebHooks peuvent déclencher l'exécution d'une tâche ou d'un plan de Job sur appel depuis une application externe.
Remarque : Pour pouvoir exécuter une tâche via un WebHook, le Job source doit contenir un paramètre de contexte nommé resource_webhook_payload. Pour les plans, au moins une tâche de la première étape doit avoir un Job source avec le paramètre de contexte.
Chaque appel de l'endpoint du WebHook est intégré dans la structure JSON suivante, passée à l'exécution du Job via le paramètre resource_webhook_payload :
  • type : type de médias du payload provenant de l'en-tête Content-Type.
  • data : données du payload
Les types de payload suivants sont supportés :
  • application/xml
  • application/json
  • application/x-www-form-urlencoded
  • text/plain
  • text/xml

Les payloads sont traités comme des tableaux. La taille totale des payloads pour les Jobs Big Data ne doit pas dépasser 5 kilo-octets.

Lorsque vous générez une URL de WebHook dans Talend Cloud Management Console, vous devez configurer les paramètres suivants :
  • Window threshold : définit le nombre d'appels du service.
  • Window duration (in seconds) : définit la durée en secondes après le premier appel au service.

Le premier événement qui survient déclenche l'exécution.

Restriction : La même tâche ou le même plan peut se trouver un maximum de 50 fois dans la file d'exécution (au statut Running) sur une période de 60 minutes. Si vous avez ordonnancé une tâche ou un plan via l'API publique ou via un WebHook afin de l'exécuter un plus grand nombre de fois, chaque nouvelle exécution sera ajoutée à la file après que la limite est atteinte.

Example (Exemple)

Si la taille de la fenêtre est 2, au cours du temps configuré dans le paramètre Window threshold, deux payloads consécutifs sont envoyés à l'endpoint du WebHook :

{"param":"1"}
{"param":"2"}
Cependant, l'exécution de la tâche/du plan ne les reçoit pas comme des payloads séparés mais comme un tableau :
[
{"data":"{\"param\":\"1\" }","type":"application/json;charset\u003dUTF-8"},
{"data":"{\"param\":\"2\" }","type":"application/json;charset\u003dUTF-8"}
]