Webhooks — référence de l’API v1

Notifications signées HMAC. Référence générée depuis les schémas de validation de l’API : ce que vous lisez est ce que le serveur vérifie.

post/webhook-endpoints — Créer un endpoint
get/webhook-endpoints — Lister les endpoints
delete/webhook-endpoints/{id} — Supprimer un endpoint

Base : https://preprod-app.signatik.com/api/v1 · authentification Authorization: Bearer sk_… · erreurs { "error": { "code", "message" } }.

post/api/v1/webhook-endpoints

Créer un endpoint

La réponse contient secret (affiché une seule fois). Chaque livraison porte X-Esign-Event et X-Esign-Signature: sha256=<HMAC-SHA256(secret, corps brut)> ; 8 tentatives avec attente exponentielle tant que vous ne répondez pas 2xx. Événements : envelope.completed, envelope.expired, mandate.activated, seal_batch.applied, attendance.session_closed. Scope webhooks:manage.

●POST /webhook-endpoints

curl -X POST https://preprod-app.signatik.com/api/v1/webhook-endpoints \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://votre-app.fr/webhooks/esign"
}'

●201 — exemple de réponse

{
  "id": "8f2c1d4e-0b7a-4c1e-9f0d-6a3b2c1d0e9f",
  "url": "https://votre-app.fr/webhooks/esign",
  "active": true,
  "secret": "…"
}

Corps de la requête

Champ	Type	Description
`url`requis	string

Réponses

`201`	OK
`400`	URL https:// requise
`401`	Clé absente, mal formée ou révoquée (`unauthorized`)
`403`	Scope manquant sur la clé (`forbidden`)
`429`	Limitation de débit (`rate_limited`, en-tête `Retry-After`)

Réponse 201

Champ	Type	Description
`id`requis	uuid
`url`requis	string
`active`requis	boolean
`secret`requis	string

get/api/v1/webhook-endpoints

Lister les endpoints

●GET /webhook-endpoints

curl -X GET https://preprod-app.signatik.com/api/v1/webhook-endpoints \
  -H "Authorization: Bearer sk_test_…"

●200 — exemple de réponse

{
  "data": [
    {
      "id": "8f2c1d4e-0b7a-4c1e-9f0d-6a3b2c1d0e9f",
      "url": "https://votre-app.fr/webhooks/esign",
      "active": true
    }
  ]
}

Réponses

`200`	OK
`401`	Clé absente, mal formée ou révoquée (`unauthorized`)
`403`	Scope manquant sur la clé (`forbidden`)
`429`	Limitation de débit (`rate_limited`, en-tête `Retry-After`)

Réponse 200

Champ	Type	Description
`data`requis	object[]
`id`requis	uuid
`url`requis	string
`active`requis	boolean

delete/api/v1/webhook-endpoints/{id}

Supprimer un endpoint

●DELETE /webhook-endpoints/{id}

curl -X DELETE https://preprod-app.signatik.com/api/v1/webhook-endpoints/env_8f2c… \
  -H "Authorization: Bearer sk_test_…"

●200 — exemple de réponse

{
  "id": "8f2c1d4e-0b7a-4c1e-9f0d-6a3b2c1d0e9f",
  "active": false
}

Paramètres de chemin

id uuid

Réponses

`200`	OK
`401`	Clé absente, mal formée ou révoquée (`unauthorized`)
`403`	Scope manquant sur la clé (`forbidden`)
`404`	Introuvable
`429`	Limitation de débit (`rate_limited`, en-tête `Retry-After`)

Réponse 200

Champ	Type	Description
`id`requis	uuid
`active`requis	false