Recevoir les mises à jour en temps réel

Fonctionnement des webhooks

• Les webhooks sont un moyen de vous notifier lorsque certains événements se produisent sur la plateforme Stonal.
• Ils fonctionnent en appelant un point de terminaison HTTP de votre choix de votre côté lorsqu'un événement survient.
• Ils ne sont actuellement disponibles que pour les événements liés aux documents.
• Ils couvrent toutes les modifications apportées aux documents, y compris la création, la mise à jour et la suppression, et sont déclenchés aussi bien pour les modifications manuelles que pour les modifications automatisées (par exemple, OCR, classification par IA, etc.).

Comment utiliser les webhooks

1. Vous enregistrez un point de terminaison de webhook
2. Lorsqu'un document change dans votre organisation, Stonal envoie une requête HTTP POST avec une charge utile JSON à votre point de terminaison
3. Votre point de terminaison traite la notification et répond avec un code de statut 200 OK

Enregistrer un webhook

Les webhooks sont enregistrés par organisation en contactant l'équipe de support Stonal.

Nous ferons mieux

Nous permettrons d'enregistrer les webhooks directement depuis la plateforme à l'avenir.

Événements

Les seuls événements actuellement pris en charge concernent le cycle de vie des documents : création, mise à jour et suppression de documents.

Document créé / mis à jour

Cet événement est déclenché lorsqu'un document est créé ou mis à jour. Les deux opérations possèdent exactement la même charge utile document.

Charge utile

{
    "organizationCode": "SAMPLE_ORG",
    "type": "document_change",
    "operation": "create",
    "document": {
        "id": "efb614e6-f1b9-4829-acc4-2c8e26ab909a",
        "name": "test.pdf",
        "type": "application/pdf",
        "metadata": {
            "KEY_1": "VALUE_1",
            "KEY_2": "VALUE_2"
        }
    }
}

Description des champs

Champ	Description
organizationCode	L'identifiant unique de votre organisation dans Stonal
type	Le type d'événement, dans ce cas document_change
operation	L'opération effectuée, dans ce cas create ou update
document.id	L'identifiant unique du document créé
document.name	Le nom de fichier du document
document.type	Le type MIME du document
document.metadata	Les paires clé-valeur de métadonnées personnalisées associées au document

Document supprimé

Cet événement est déclenché lorsqu'un document est supprimé.

Charge utile

{
    "organizationCode": "SAMPLE_ORG",
    "type": "document_change",
    "operation": "delete",
    "document": {
        "id": "efb614e6-f1b9-4829-acc4-2c8e26ab909a"
    }
}

Implémentation du serveur

Votre point de terminaison doit répondre avec un code de statut 200 OK à la requête du webhook. Dans le cas contraire, le webhook sera réessayé jusqu'à 3 fois.

Notes

Nombre de charges utiles en file d'attente

Il n'y a aucune limite au nombre de charges utiles en file d'attente pouvant vous être transmises. Elles sont actuellement envoyées séquentiellement par organisation, mais cela pourrait changer à l'avenir.