Passer au contenu principal
GET
curl

​
État de la destination

health_status résume la manière dont une destination a répondu aux tentatives de livraison qui lui ont été adressées. Une tentative échouée est une tentative à laquelle la destination a répondu avec un code HTTP 400 ou supérieur, ou à laquelle elle n’a pas répondu du tout (délai dépassé, connexion refusée ou adresse bloquée). Les nouvelles tentatives ne s’ajoutent pas à failing_streak, et toute tentative réussie, y compris une nouvelle tentative ou un renvoi, met fin à la série. health_status est indépendant de enabled. Les métriques de livraison et daily_points couvrent les 30 derniers jours (metrics_window_days). daily_points contient toujours 30 entrées, une par jour UTC, de la plus ancienne à la plus récente.

​
Voir aussi

Autorisations

​
x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Réponse

Liste des destinations de webhook (non paginée, de la plus ancienne à la plus récente).

​
uuid
string<uuid>

Identifiant stable de la destination ; à utiliser comme {destination_uuid} pour la mise à jour ou la suppression.

​
label
string

Nom lisible par l'humain affiché dans la Console.

​
url
string<uri>

URL de destination qui reçoit les requêtes POST avec le payload du webhook.

​
enabled
boolean

Lorsque la valeur est false, Didit ignore silencieusement la livraison vers cette destination.

​
webhook_version
enum<string>

Version du schéma de payload envoyée à cette destination. v3 est le format actuel/recommandé.

Options disponibles:
v1,
v2,
v3
​
subscribed_events
enum<string>[]

Filtre d'événements pour cette destination de webhook. Didit ne livre que les webhooks dont le type d'événement correspond exactement à l'une de ces valeurs — il n'y a pas d'abonnement avec caractère générique. Lorsqu'elle est envoyée, la liste doit contenir au moins un événement valide (un [] explicite est rejeté avec une erreur 400) ; une destination dont la liste est vide (champ omis lors de la création) ne reçoit rien. Lors d'une mise à jour, la liste est entièrement remplacée, jamais fusionnée.

Minimum array length: 1

Nom d'événement webhook pris en charge. Utilisez ces chaînes exactes dans subscribed_events ; les valeurs non prises en charge sont rejetées.

Options disponibles:
status.updated,
data.updated,
user.status.updated,
user.data.updated,
business.status.updated,
business.data.updated,
activity.created,
transaction.created,
transaction.status.updated,
travel_rule.status.updated,
workflow.compliance_changed,
transaction_rule_suggestions.created,
auth.signup,
auth.login,
auth.login_failed,
auth.password_reset_requested,
auth.password_reset_completed,
auth.mfa_changed,
auth.new_device,
auth.account_locked,
investigator.report.ready,
investigator.decision.automated,
investigator.decision.overridden,
investigator.decision.contested,
investigator.question.raised,
investigator.automation.paused,
investigator.rfi.answered,
investigator.rfi.overdue,
investigator.drift.detected,
investigator.sla.breached,
investigator.qa.failed,
investigator.external.report.ready
Exemple:
​
subscribed_events_count
integer

Longueur en cache de subscribed_events, utile pour le rendu de l'interface utilisateur.

​
deliveries_count
integer

Tentatives de livraison (nouvelles tentatives incluses) effectuées vers cette destination au cours des 30 derniers jours.

​
failed_deliveries_count
integer

Tentatives de livraison au cours des 30 derniers jours auxquelles la destination a répondu par HTTP 400 ou plus, ou n'a pas répondu (délai d'attente dépassé, connexion refusée ou adresse bloquée).

​
average_response_time_ms
integer | null

Temps de réponse moyen en millisecondes au cours des 30 derniers jours, arrondi à l'entier le plus proche. null s'il n'y a eu aucune livraison pendant cette période.

​
error_rate_percentage
integer

round(failed_deliveries_count / deliveries_count * 100) sur les 30 derniers jours ; 0 lorsqu'il n'y a aucune livraison.

​
last_delivery_at
string<date-time> | null

Horodatage de la tentative de livraison la plus récente (succès ou échec). null si aucune livraison n'a été effectuée.

​
metrics_window_days
integer

Durée en jours de la fenêtre couverte par deliveries_count, failed_deliveries_count, average_response_time_ms, error_rate_percentage et daily_points. Toujours 30.

​
health_status
enum<string>

État de la livraison. failing : 3 événements consécutifs ou plus ont échoué lors de leur première tentative de livraison depuis la dernière réponse réussie de la destination (voir failing_streak). degraded : pas en échec, mais une tentative de livraison a échoué au cours des dernières 24 heures et aucune tentative ultérieure n'a livré cet événement ; une nouvelle tentative ou un renvoi qui le livre efface cet état. healthy : aucun des deux. Indépendant de enabled. Une tentative échouée correspond à une réponse HTTP 400 ou supérieure, ou à une absence totale de réponse.

Options disponibles:
healthy,
degraded,
failing
​
failing_streak
integer

Nombre d'événements consécutifs dont la première tentative de livraison a échoué depuis la dernière réponse réussie de la destination, au cours des 30 derniers jours. Les nouvelles tentatives ne sont pas comptabilisées, et toute tentative réussie, y compris une nouvelle tentative ou un renvoi, met fin à la série. 0 lorsqu'aucun événement n'a échoué depuis le dernier succès.

​
failing_since
string<date-time> | null

Date et heure de la première tentative infructueuse de la série d'échecs en cours (failing_streak). null lorsque failing_streak vaut 0.

​
last_success_at
string<date-time> | null

Date et heure auxquelles la destination a répondu pour la dernière fois à une livraison avec un statut HTTP inférieur à 400, au cours des 30 derniers jours. null si ce n'est pas le cas dans cet intervalle.

​
environment
enum<string>

Environnement de l'application propriétaire de la destination.

Options disponibles:
live,
sandbox
​
daily_points
object[]

Une entrée par jour UTC des 30 derniers jours, de la plus ancienne à la plus récente, y compris les jours sans aucune livraison. Prend en compte chaque tentative, nouvelles tentatives incluses.

​
secret_last4
string

Quatre derniers caractères du secret de signature actuel de la destination, vous permettant de distinguer les secrets. Insuffisant pour vérifier une signature.

​
created_by_email
string | null

E-mail du membre de la Business Console qui a créé la destination. null pour une destination créée avec une clé API.

​
created_by_name
string | null

Nom du membre de la Business Console ayant créé la destination. null pour une destination créée avec une clé API.

​
created_at
string<date-time>
​
updated_at
string<date-time>
Dernière modification le 7 novembre 2026