Webhook AIDA
Le Webhook est une Destination qui permet à AIDA d'appeler automatiquement un point de terminaison (endpoint) HTTPs chaque fois qu'un document est traité par ce flux. AIDA effectuera un appel HTTP POST avec une charge utile (payload) JSON à l'URL configurée.
Configuration
Le comportement du webhook est contrôlé par les paramètres suivants dans la configuration de la destination :
Paramètre | Requis | Description | Valeur par défaut |
---|---|---|---|
URL du Webhook | Oui | L'URL du point de terminaison HTTPS qu'AIDA appellera. | - |
En-tête d'autorisation | Non | La valeur pour l'en-tête HTTP Authorization . Par exemple : Bearer votre-jeton-secret . | - |
Action du Webhook | Non | Une valeur de type chaîne de caractères qui sera ajoutée à la charge utile JSON dans le champ action . Peut être utilisée pour identifier le type d'événement côté récepteur. | - |
Mode d'envoi du document | Non | Définit comment le fichier PDF du document est envoyé. | Intégrer une URL de téléchargement dans la charge utile |
Expiration | Non | Expiration du lien pour le téléchargement du document. | 7 jours |
Ajouter le contenu du document | Non | Si activé, ajoute un champ content à la charge utile contenant le texte intégral du document, extrait par l'OCR. | Désactivé |
Ignorer la vérification du certificat SSL/TLS | Non | À utiliser avec prudence. Si activé, AIDA ne validera pas le certificat SSL du point de terminaison. Utile pour les tests avec des certificats auto-signés. | Désactivé |
En-têtes HTTP
AIDA enverra les en-têtes suivants avec la requête POST :
Content-Type: application/json
Accept: application/json
Authorization
: La valeur fournie dans le paramètre de configuration En-tête d'autorisation, le cas échéant.
Charge utile JSON (Payload)
La charge utile se compose d'une série de paires clé-valeur. Certains sont des champs standards fournis par AIDA, tandis que d'autres correspondent aux propriétés extraites du document.
Champs Standards
Ces champs sont automatiquement ajoutés par AIDA en fonction de la configuration.
Champ | Type | Description |
---|---|---|
action | string | La valeur de la configuration Action du Webhook. Présent uniquement si configuré. |
documentURL | string | Un lien permanent pour visualiser le document dans l'application web AIDA. |
downloadURL | string | Un lien temporaire et sécurisé pour télécharger le fichier PDF du document. Présent uniquement si le Mode d'envoi du document est réglé sur téléchargement (par défaut). |
attachment | string | Le contenu encodé en Base64 du fichier PDF du document. Présent uniquement si le Mode d'envoi du document est réglé pour intégrer le fichier. |
content | string | Le contenu textuel intégral du document. Présent uniquement si l'option Ajouter le contenu du document est activée. |
Propriétés du Document
Ces champs correspondent aux données extraites du document.
- Clé : La clé JSON pour chaque propriété est déterminée par sa configuration de "Mapping de sortie". Si celui-ci n'est pas défini, le Libellé de la propriété est utilisé.
- Types de données : Les propriétés sont automatiquement converties dans le type JSON correct (par ex.,
Number
,Boolean
,String
) en fonction de leur configuration dans AIDA. Les dates sont représentées en tant qu'horodatage UNIX (timestamp) en millisecondes. - Tableaux : Les propriétés faisant partie d'un tableau seront regroupées dans un tableau JSON. La clé de ce tableau est déterminée par le "Mapping de sortie" du groupe de tableau ou, s'il n'est pas défini, par son Nom.
Exemple
Étant donné un type de document avec les propriétés suivantes :
Propriétés d'en-tête
Numéro de facture
(Libellé :Numéro de facture
, Mapping de sortie : non configuré, Type :String
)Date de facture
(Libellé :Date de facture
, Mapping de sortie :invoiceDate
, Type :Date
)Montant total
(Libellé :Montant total
, Mapping de sortie :total
, Type :Currency
)
Groupe de propriétés de tableau (Nom : Lignes de facture
, Mapping de sortie : lines
) :
Description
(Mapping de sortie :description
, Type :String
)Quantité
(Mapping de sortie :qty
, Type :Number
)Prix unitaire
(Mapping de sortie :unitPrice
, Type :Currency
)
Et la configuration de destination AIDA suivante :
- URL du Webhook :
https://api.monentreprise.com/invoice-receiver
- Action du Webhook :
NEW_INVOICE
- Mode d'envoi du document : téléchargement
La charge utile JSON résultante envoyée au point de terminaison ressemblerait à ceci :
{
"Numéro de facture": "INV-2025-042",
"invoiceDate": 1760444400000,
"total": 122.00,
"lines": [
{
"description": "Produit A",
"qty": 2,
"unitPrice": 50.00
},
{
"description": "Service B",
"qty": 1,
"unitPrice": 22.00
}
],
"action": "NEW_INVOICE",
"documentURL": "[https://aida.monentreprise.com/app/web/archive/12345](https://aida.monentreprise.com/app/web/archive/12345)",
"downloadURL": "[https://api.aida.monentreprise.com/asset/document/generated-auth-token](https://api.aida.monentreprise.com/asset/document/generated-auth-token)"
}