io.enterpriseai.resources.WebhooksClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/WebhooksClient.java. Retour à l'index de la référence du SDK Java.
Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.
Classe WebhooksClient
Connecteurs. Connector Hub : registre des connexions aux systèmes externes (applications SaaS, API, sources de données), leurs identifiants conservés côté serveur, les exécutions de synchronisation, le Credential Broker qui remet des baux de courte durée à la place des secrets, et la Webhook Gateway qui reçoit les événements signés des fournisseurs.
Attributs :
| Nom | Type | Requis | Description |
|---|---|---|---|
DEFAULT_TOLERANCE_SECONDS | long | oui | Fenêtre anti-rejeu par défaut de #verify, en secondes. |
Constructeur WebhooksClient
WebhooksClient(Transport transport)
Crée le client sur le transport partagé ; EnterpriseAIClient le construit, on y accède par l'accesseur du même nom.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
transport | Transport | oui | Transport partagé par les sous-clients d'un même client. |
WebhooksClient.deliver
JsonNode deliver(String connector, Object body)
Recevoir un webhook de fournisseur. Point d'entrée du fournisseur, sans authentification de la plateforme. En-têtes : X-EAI-Tenant (slug du tenant, sinon 400 tenant_required), X-EAI-Signature (t=<secondes unix>,v1=<HMAC-SHA256 hexadécimal de "<t>." + corps brut> ; X-EAI-Timestamp peut porter l'horodatage), X-EAI-Delivery facultatif (identifiant de dédoublonnage). Étapes : 1. Le connecteur doit exister, être actif et avoir les webhooks activés (404 connector_not_found). 2. Signature vérifiée avec le webhook_secret enregistré ou la référence de secret du manifeste (401 invalid_signature) ; horodatage à moins de 5 minutes (401 webhook_replay) ; une livraison déjà acceptée répond 409 webhook_duplicate. 3. Le corps JSON est contrôlé comme contenu non fiable (injection de prompt bloquée), puis publié sous connectors.<nom>.webhook, ce qui peut lancer des runs déclenchés. Répond 202 avec delivery_id, event_id et triggered. Chaque livraison est enregistrée et auditée sous webhook.receive.
Route : /v1/webhooks/{connector} (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
connector | String | oui | Nom du connecteur auquel le fournisseur envoie. | |
body | Object | oui | Charge utile brute du fournisseur ; la signature est vérifiée sur ces octets exacts, quel que soit le type de contenu. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Recevoir un webhook de fournisseur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
WebhooksClient.deliver
JsonNode deliver(String connector, Object body, RequestOptions options)
Recevoir un webhook de fournisseur. Point d'entrée du fournisseur, sans authentification de la plateforme. En-têtes : X-EAI-Tenant (slug du tenant, sinon 400 tenant_required), X-EAI-Signature (t=<secondes unix>,v1=<HMAC-SHA256 hexadécimal de "<t>." + corps brut> ; X-EAI-Timestamp peut porter l'horodatage), X-EAI-Delivery facultatif (identifiant de dédoublonnage). Étapes : 1. Le connecteur doit exister, être actif et avoir les webhooks activés (404 connector_not_found). 2. Signature vérifiée avec le webhook_secret enregistré ou la référence de secret du manifeste (401 invalid_signature) ; horodatage à moins de 5 minutes (401 webhook_replay) ; une livraison déjà acceptée répond 409 webhook_duplicate. 3. Le corps JSON est contrôlé comme contenu non fiable (injection de prompt bloquée), puis publié sous connectors.<nom>.webhook, ce qui peut lancer des runs déclenchés. Répond 202 avec delivery_id, event_id et triggered. Chaque livraison est enregistrée et auditée sous webhook.receive.
Route : /v1/webhooks/{connector} (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
connector | String | oui | Nom du connecteur auquel le fournisseur envoie. | |
body | Object | oui | Charge utile brute du fournisseur ; la signature est vérifiée sur ces octets exacts, quel que soit le type de contenu. | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Recevoir un webhook de fournisseur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
WebhooksClient.deliverSigned
JsonNode deliverSigned(String connector, byte[] payload, String secret, String tenant)
Recevoir un webhook de fournisseur. Point d'entrée du fournisseur, sans authentification de la plateforme. En-têtes : X-EAI-Tenant (slug du tenant, sinon 400 tenant_required), X-EAI-Signature (t=<secondes unix>,v1=<HMAC-SHA256 hexadécimal de "<t>." + corps brut> ; X-EAI-Timestamp peut porter l'horodatage), X-EAI-Delivery facultatif (identifiant de dédoublonnage). Étapes : 1. Le connecteur doit exister, être actif et avoir les webhooks activés (404 connector_not_found). 2. Signature vérifiée avec le webhook_secret enregistré ou la référence de secret du manifeste (401 invalid_signature) ; horodatage à moins de 5 minutes (401 webhook_replay) ; une livraison déjà acceptée répond 409 webhook_duplicate. 3. Le corps JSON est contrôlé comme contenu non fiable (injection de prompt bloquée), puis publié sous connectors.<nom>.webhook, ce qui peut lancer des runs déclenchés. Répond 202 avec delivery_id, event_id et triggered. Chaque livraison est enregistrée et auditée sous webhook.receive.
Route : /v1/webhooks/{connector} (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
connector | String | oui | Nom du connecteur auquel le fournisseur envoie. | |
payload | byte[] | oui | Charge utile brute du fournisseur ; la signature est vérifiée sur ces octets exacts, quel que soit le type de contenu. | |
secret | String | oui | Secret partagé de la signature HMAC-SHA256 placée dans X-EAI-Signature. | |
tenant | String | oui | Slug du tenant envoyé dans X-EAI-Tenant. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Recevoir un webhook de fournisseur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
WebhooksClient.deliverSigned
JsonNode deliverSigned(String connector, byte[] payload, String secret, String tenant, String deliveryId)
Recevoir un webhook de fournisseur. Point d'entrée du fournisseur, sans authentification de la plateforme. En-têtes : X-EAI-Tenant (slug du tenant, sinon 400 tenant_required), X-EAI-Signature (t=<secondes unix>,v1=<HMAC-SHA256 hexadécimal de "<t>." + corps brut> ; X-EAI-Timestamp peut porter l'horodatage), X-EAI-Delivery facultatif (identifiant de dédoublonnage). Étapes : 1. Le connecteur doit exister, être actif et avoir les webhooks activés (404 connector_not_found). 2. Signature vérifiée avec le webhook_secret enregistré ou la référence de secret du manifeste (401 invalid_signature) ; horodatage à moins de 5 minutes (401 webhook_replay) ; une livraison déjà acceptée répond 409 webhook_duplicate. 3. Le corps JSON est contrôlé comme contenu non fiable (injection de prompt bloquée), puis publié sous connectors.<nom>.webhook, ce qui peut lancer des runs déclenchés. Répond 202 avec delivery_id, event_id et triggered. Chaque livraison est enregistrée et auditée sous webhook.receive.
Route : /v1/webhooks/{connector} (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
connector | String | oui | Nom du connecteur auquel le fournisseur envoie. | |
payload | byte[] | oui | Charge utile brute du fournisseur ; la signature est vérifiée sur ces octets exacts, quel que soit le type de contenu. | |
secret | String | oui | Secret partagé de la signature HMAC-SHA256 placée dans X-EAI-Signature. | |
tenant | String | oui | Slug du tenant envoyé dans X-EAI-Tenant. | |
deliveryId | String | oui | Identifiant de livraison envoyé dans X-EAI-Delivery ; sans lui, un identifiant dlv- aléatoire est généré. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Recevoir un webhook de fournisseur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
WebhooksClient.deliveries
Page<JsonNode> deliveries()
Lister les livraisons de webhooks. Livraisons de webhooks reçues, de la plus récente à la plus ancienne : connecteur, identifiant de livraison, validité de la signature, statut (accepted, rejected, duplicate), raison, SHA-256 de la charge utile et événement publié. La charge utile elle-même n'est pas conservée ici.
Route : /v1/webhooks/deliveries (GET).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les livraisons de webhooks ».
Erreurs levées : les erreurs typées du transport (Erreurs).
WebhooksClient.deliveries
Page<JsonNode> deliveries(Map<String, ?> query)
Lister les livraisons de webhooks. Livraisons de webhooks reçues, de la plus récente à la plus ancienne : connecteur, identifiant de livraison, validité de la signature, statut (accepted, rejected, duplicate), raison, SHA-256 de la charge utile et événement publié. La charge utile elle-même n'est pas conservée ici.
Route : /v1/webhooks/deliveries (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les livraisons de webhooks ».
Erreurs levées : les erreurs typées du transport (Erreurs).