Docage API
French
  • French
  • Spanish
    Docage API
    French
    • French
    • Spanish
    • Requêtes communes
      • Créer un objet
        • Créer un objet
      • Modifier un objet
        • Modifier un objet
      • Suppression des objets
        • Supprimer un objet
        • Supprimer plusieurs objets
      • Récupération des objets
        • Récupérer tous les objets
          • Récupérer une liste d'objets
            • Récupérer tous les contacts
            • Récupérer tous les parcours
            • Récupérer tous les classeurs
          • Récupérer les modèles de parcours
          • Requêter certaines propriétés uniquement
        • Récupérer un seul objet
          • Récupérer un objet par son Id
          • Récupérer un contact par son email
          • Récupérer un utilisateur par son email
        • Récupérer une liste filtrée
          • Filtrer les transactions en cours
          • Filtrer les transactions supérieure à une date
          • Filtrer les transactions signées ET dont le nom contient "Facture"
          • Filtrer les contacts qui s'appellent Léo ou Paul ET dont l'email se termine par gmail.com
          • Filtrer les contacts en fonction des champs personnalisés
        • Récupérer les objets d'un classeur
          • Récupérer les contacts d'un classeur
        • Récupérer une liste triée
          • Trier les contacts par leur prénom
          • Trier les contacts par leur prénom en ordre décroissant
          • Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
        • Récupérer une liste paginée
          • Trier les contacts par leur prénom
          • Trier les contacts par leur prénom en ordre décroissant
          • Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
    • Docage Sign
      • Créer un parcours en une requête
        • Sans modèle de parcours
          • Avec contact existant
          • Avec création d'un contact
          • Avec plusieurs signatures pour un contact
          • Avec modification d'un contact existant
          • Créer un brouillon (sans lancement)
          • Avec fourniture des Ids par le développeur
        • Avec un modèle de parcours
          • Sans modification
            • Sans modification
          • Remplacement d'un membre
            • Par un contact existant
            • Par un nouveau contact
          • Remplacement d'un document
            • Avec un nouveau fichier
            • Avec un modèle de document Docage
          • Ajout d'un membre (à venir)
            • Avec un nouveau contact (à venir)
            • Avec un contact existant (à venir)
          • Ajout d'un document (à venir)
            • Avec un nouveau fichier (à venir)
          • Autres exemples
            • Créer un brouillon (sans lancement)
            • Avec modification des propriétés héritées du modèle
            • Avec modification du mode de signature
      • Création pas à pas
        • Créer une transaction
        • Ajouter un document à la transaction
        • Ajouter un membre à la transaction
        • Ajouter une signature visuelle
        • Lancer une transaction
      • Téléchargement des documents
        • Télécharger un document précis d'une transaction
        • Télécharger tous les documents d'une transaction
        • Télécharger le fichier de preuve
        • Télécharger tous les documents et le fichier de preuve d'une transaction
      • Signer plusieurs transactions en une fois
        • Vérifier la signabilité des transactions
        • Envoyer un code de signature pour signer plusieurs transactions en une fois
        • Signer plusieurs transactions avec un code unique
      • Autres requêtes pour les transactions
        • Récupérer le statut d'une transaction
        • Annuler une transaction
        • Envoyer un rappel
        • Supprimer un/des membres d'une/plusieurs transactions
        • Supprimer un/des fichiers d'une/plusieurs transactions
      • Gestion des signatures visuelles
    • Docage Mail
    • Webhook
      • Etre notifié lorsqu'un objet change d'état
        • Etre notifié lorsqu'une Transaction est supprimée
        • Etre notifié lorsqu'un Utilisateur est bloqué
        • Etre notifié lorsqu'un Utilisateur est débloqué
      • Etre notifié lorsqu'un objet est modifié
        POST
      • Etre notifié lorsqu'une Transaction change de statut
        POST
      • Etre notifié lorsque le contenu d'un classeur est modifié
        POST
      • Etre notifié lorsqu'un formulaire Web est rempli
        POST
      • Etre notifié de l'état de Docage
        POST
      • Supprimer un Webhook par son Id
        DELETE
      • Supprimer plusieurs Webhooks par leur Url
        DELETE
      • Créer un Webhook
        POST
    • Redirections
    • Marque blanche
    • Champs personnalisés
      • Créer une entité avec ses champs personnalisés
        POST
      • Modifier les champs personnalisés d'une entité
        PUT
      • Créer une transaction en renseignant ses champs personnalisés
        POST
    • Organisations
      • Créer une organisation cliente
      • Créer un utilsateur
    • Classeurs
      • Requêtes spécifiques aux classeurs
        • Ajouter des entités à un classeur
        • Supprimer des entités d'un classeur
        • Suppression d'un/plusieurs classeurs avec leur contenu
      • Récupérer les objets d'un classeur
        • Récupérer les transactions d'un classeur
      • Liaisons lors de la création d'un objet
        • Ajouter un objet à un ou plusieurs classeurs à la création
      • Modification des liaisons lors de la modification d'un objet
        • Ajouter un objet à un ou plusieurs classeurs à la modification
        • Supprimer un objet d'un ou plusieurs classeurs à la modification
      • Modification des liaisons entre un objet et les classeurs
        • Ajouter un objet à un/des classeurs
        • Supprimer un objet d'un ou plusieurs classeurs
      • Créer un classeur
      • Modifier un classeur
      • Supprimer un classeur
      • Supprimer plusieurs classeurs
    • Etat des services Docage
    • Créer un Webhook
      POST

      Créer un Webhook

      POST
      /Webhooks
      Pour créer un Webhook vous devez définir l'URL, le périmètre, l'évènement concerné ainsi qu'un éventuel paramètre d'évènement

      Définition de l'Url#

      Renseignez la propriété Url qui recevra la requête POST en temps réel à chaque fois que l'évènement se déclenche. Par exemple :
      "Url": "https://www.clientheureux.com/endpoint"

      Définition du périmètre#

      Tous les objets d'un certain type#
      Renseignez la propriété EntityTypeName.
      Par exemple pour tous les contacts :
      "EntityTypeName": "Contact"
      Voici les types d'objet que vous pouvez cibler :
      ValeurDescription
      BoxClasseur
      BoxFileFichier de classeur
      CircleCercle
      ContactContact
      FormFormulaire
      MailboxCompte email
      DocageUserUtilisateur
      OrganizationOrganisation
      DocumentDocument
      TransactionTransaction
      Tous les objets créés à partir d'un modèle#
      Renseignez l'Id du modèle dans la propriété correspondante.
      Par exemple pour un modèle de transaction :
      "TransactionId": "4d8ad20e-1486-4bbd-a758-1e39579d52fc"
      Un objet unique#
      Renseignez l'Id de l'objet dans la propriété correspondante.
      Par exemple pour un classeur :
      "BoxId": "08c0f5cf-a461-46d0-b520-b8ce53446eea"

      Définition de l'évènement Action#

      ValeurDescriptionUtilisable avec
      0SuppressionTous les objets
      1CréationTous les objets
      2ModificationTous les objets
      3Changement d'étatTous les objets
      10Suppression d'un objet dans un classeurClasseur
      11Ajout d'un objet dans un classeurClasseur
      20Changement de statut d'une transactionTransaction

      Request

      Authorization
      Send your HTTP requests with an
      Authorization
      header that contains the word Basic followed by a space and a base64-encoded string username:password
      Example:
      Authorization: Basic *****************
      Header Params

      Body Params application/json

      Examples

      Responses

      🟢200Success
      application/json
      Body

      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request POST 'https://api.docage.com/Webhooks' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Url": "https://www.clientheureux.com/endpoint",
    "Name": "Contact Modification",
    "Description": "Modification des contacts",
    "EntityTypeName": "Contact",
    "Action": "2"
}'
      Response Response Example
      {}
      Modified at 2025-10-24 08:42:39
      Previous
      Etat des services Docage
      Built with