Vue Générale
Si le produit Validis API est activé, l'option d'utiliser un Webhook pour les notifications, est disponible. Les notifications seront alors envoyées à chaque changement de statut des téléchargements
Configuration
Pour accéder aux paramètres du Webhook, sélectionnez votre compte utilisateur en haut à droite et cliquez sur Paramètres.
Sur le côté gauche, sélectionnez Intégrations, puis l'option Webhook.
Les utilisateurs avec les accès requis auront la possibilité de paramètrer la configuration dans la rubrique de Configuration du Système sus Validis Admin.
Vous pourrez alors gérer les configurations suivantes:
- Webhook bouton On/Off
- Webhook URL – Configurer l'URL contenant le bon protocole vers lequel le message sera envoyé
Le format du message sera:
{
"event": "String",
"status": "String",
"clientId": "uuid",
"engagementId": "integer",
"externalEngagementId": "integer",
"uploadId": "uuid",
"apiUrl": "url"
}
Les champs contiendront les détails suivants:
event – Ceci est Téléchargement car pour le moment, l'unique service webhook que nous fournissons est sur le changement du statut de téléchargement.
status – Ceci est le statut de téléchargement parmis les suivants: Loading, Aborted, Processing, Failed or Completed (Reportez-vous à la fin de l'article pour les équivalents en français)
clientId – Ceci est votre identifiant unique.
engagementId – Ceci est l'identifiant unique du mandat.
uploadId – Ceci est l'identifiant unique du téléchargement.
apiUrl – Ceci est l'url à utiliser quand vous réclamez les données via API.
Une fois les modifications effectuées, cliquez sur 'ENREGISTRER' pour enregistrer les modifications.
Statuts de téléchargement:
Loading: Démarré
Aborted: Abandonné
Processing: En cours
Failed: Erreur
Completed: Terminé.