Application de workflow SENDHTTPPOST

Aperçu

L’application de workflow SENDHTTPPOST permet d’envoyer des requêtes HTTP « webhook » à des systèmes externes. Les webhooks permettent à une API d’échanger des informations avec d’autres applications via des requêtes HTTP POST et peuvent être utilisés pour créer des intégrations avec des applications extensibles telles que Slack, GitHub et Dropbox. Par exemple, les webhooks peuvent être utilisés pour des notifications quand un événement prévu (configuré par l’utilisateur) soit survenu. En permettant une communication en temps réel, les webhooks sont efficaces et performants.

L’application de workflow SENDHTTPPOST envoie des webhooks sortants à des applications externes en utilisant des charges utiles (« payloads ») JSON ou URLENCODED. Ensuite, SENDHTTPPOST reçoit et traîte la réponse de l’API externe. Pour plus d’informations, voir l’article Using webhooks with WorkflowGen.

Pour un exemple d’utilisation de SENDHTTPPOST pour envoyer des messages depuis WorkflowGen à des canaux Slack, voir l’article Workflow Application: Using SENDHTTPPOST to send messages to Slack. Des exemples d’API qui utilisent SENDHTTPPOST sont également disponibles dans le répertoire GitHub SENDHTTPPOST Workflow Application.

Mode de fonctionnement

• L’application SENDHTTPPOST requiert le paramètre APP_URL, qui correspond à l’URL de l’API externe.

• Le formulaire doit contenir des champs textbox pour tous les paramètres utilisés, avec les données des champs correspondants aux paramètres SENDHTTPPOST.

• Le type de charge utile (« payload ») par défaut (APP_CONTENT_TYPE) est JSON; URLENCODED est également supporté.

• Le délai d’expiration (APP_TIMEOUT) par défaut est de 3000 millisecondes; le délai d’expiration maximum est de 60 000 millisecondes.

• La réponse peut contenir une charge utile facultative correspondante à des paramètres OUT définis par les utilisateurs.

• Le paramètre TOKEN (jeton) est disponible pour usage dans l’authentification API. Quand une API récupère la valeur du jeton dans le paramètre APP_URL, les deux valeurs devraient être concaténées dans le paramètre APP_URL, laissant ainsi vide le paramètre TOKEN.

• Des logs d’application sont disponibles; ceux-ci peuvent être configurés en réglant la valeur du paramètre SendHttpPostLogLevel dans le fichier « web.config » à 0 pour désactiver le logging, à 1 pour des logs simples ou à 2 pour des logs de débogage.

• En cas d’erreur quand le paramètre OUT APP_RESPONSE_STATUS n’est pas défini, une exception sera lancée.

• Étant donnée que les paramètres de l’application sont sensibles à la casse, ils doivent respecter la notation acceptée de l’API.

Paramètres

Paramètre obligatoire

Paramètre	Type	Direction	Description
APP_URL	Text	IN	URL de l’API externe

Paramètres facultatifs

Paramètre	Type	Direction	Description
TOKEN	Text	IN	Jeton d’autorisation de l’API
APP_TIMEOUT	Numeric	IN	L’intervalle maximum entre l’expédition de la requête et la réception de la réponse (par défaut : 3000 millisecondes; maximum : 60 000 millisecondes)
APP_CONTENT_TYPE	Text	IN	Type du contenu de la requête (JSON et URLENCODED sont supportés; le type par défaut est JSON)
APP_RESPONSE_CONTENT	Text	OUT	Charge utile ou message d’erreur facultatif retournée
APP_RESPONSE_STATUS	Text	OUT	Code retourné du statut de la requête HTTP