Webhook

Last updated 26 days ago

À chaque changement de statut d'un dossier (c’est à dire lors du passage en construction, en instruction ou lors de la clôture du dossier), demarches-simplifiees.fr va effectuer une requête sur une adresse web configurable par l’administrateur de la procédure.

Cette requête est un POST fait en tant que application/x-www-form-urlencoded, avec en paramètres :

  • procedure_id, l’identifiant de la procédure,

  • dossier_id, l’identifiant du dossier,

  • state, le nouvel état du dossier,

  • updated_at, la date du changement.

Votre URL sera donc appelée avec le suffixe suivant (les valeurs sont fictives) :?procedure_id=9407&dossier_id=204179&state=en_construction&updated_at=2018-10-25%2010%3A32%3A42%20UTC

Si vous souhaitez plus d’information sur le dossier, vous pouvez alors utiliser notre API pour récupérer l’intégralité des nouvelles informations du dossier concerné.

Ajouter un lien de rappel à une procédure

Pour configurer une procédure pour utiliser un lien de rappel :

  • Envoyez un message à contact@demarches-simplifiees.fr pour demander l’activation de la fonctionnalité ;

  • Une fois la fonctionnalité activée, connectez-vous en tant qu’administrateur de la procédure ;

  • Cliquez sur l’onglet « Description » dans la barre latérale ;

  • Dans la section « Lien de rappel HTTP », ajoutez l’adresse web qui sera appelée à chaque changement de dossier.