En savoir plus sur WebHook

WebHook est le canal par lequel les clients reçoivent leurs informations d'envoi. Après que l'utilisateur a envoyé la demande d'envoi à EngageLab, EngageLab renverra de manière synchrone le « résultat de la demande » à l'utilisateur, et le « résultat d'envoi » ainsi que les « autres résultats d'événements » du mail seront retournés à l'utilisateur de façon asynchrone via WebHook.

Traitement de WebHook

• EngageLab fournit aux clients certains événements d'e-mail, et les clients peuvent choisir de se concentrer sur certains événements.
• Lorsqu'un événement se produit, EngageLab sera déclenché pour envoyer des données (POST) à l'URL définie par le client.
• Type de données poussées par EngageLab : « Content-Type: application/json ».
• Le client reçoit les données et analyse l'événement et les données. Vous devez retourner le code d'état HTTP 200 sous 3 secondes. Sinon, EngageLab renverra le message.

Méthode d'utilisation

• L'utilisateur écrit le service HTTP pour lui permettre de gérer les événements correspondants, d'analyser les données pertinentes et d'ouvrir l'URL correspondante.
• L'utilisateur sélectionne l'événement concerné dans le « WebHook » d'EngageLab et configure l'URL pour recevoir les données.

Vérification de la signature

Pour garantir que l'identité de la source du message est EngageLab, vous pouvez choisir d'effectuer une authentification de sécurité sur la source des données POST (il est également possible d'analyser directement les données POST sans vérification).

La méthode d'authentification de sécurité est la suivante :

• Obtenez la APP KEY via 【Paramètres d'envoi】-【WebHook】
• Analysez le X-WebHook-Timestamp dans l'en-tête
• Analysez le X-WebHook-AppKey dans l'en-tête
• Analysez le X-WebHook-Signature dans l'en-tête
• Utilisez md5(X-WebHook-Timestamp+X-WebHook-AppKey+APP KEY) pour générer la signature signature, puis comparez-la avec X-WebHook-Signature

Traitement de la réponse

Après avoir reçu le rappel d'EngageLab, le service du développeur doit répondre dans les 3 secondes selon les exigences suivantes.

Réception réussie : le code d'état de la réponse HTTP doit être 200 ou 204, et aucun message de réponse n'a besoin d'être retourné.

Échec de la réception : le code d'état de la réponse HTTP doit être 5XX ou 4XX, et un message de réponse doit être retourné en même temps, au format suivant :

{"code":2002,"message":"failed"}

Traitement des relances

En cas d'erreur d'accès à l'URL ou de délai d'attente, EngageLab réessaiera au maximum 7 fois. L'intervalle maximal entre chaque tentative est de 3 min, 10 min, 30 min, 1 h, 6 h, 12 h et 24 h. Cela vous laisse suffisamment de temps pour réparer l'URL avant que le message ne soit perdu.

Si le nombre de tentatives est dépassé, EngageLab abandonnera le message.

Pour chaque traitement d'événement et analyse de données, vous devez retourner « Réponse reçue avec succès » sous 3 secondes. Sinon, EngageLab renverra ce message.