Webhooks

Recevez un événement HTTP sur votre propre URL plutôt que de sonder l'API.

Créer un webhook

http
POST /v1/webhooks
json
{
  "url": "https://votre-app.exemple.com/webhooks/emini",
  "events": ["job.completed", "job.failed"]
}
json
{
  "webhook": { "id": "...", "url": "https://votre-app.exemple.com/webhooks/emini", "events": ["job.completed", "job.failed"], "status": "active" },
  "secret": "whsec_..."
}
secret n'est renvoyé qu'une seule fois, à la création. Conservez-le pour vérifier la signature des livraisons.

Événements disponibles

  • job.completed — un job asynchrone (vidéo) s'est terminé avec succès
  • job.failed — un job asynchrone a échoué
  • budget.alert — un seuil d'alerte de budget projet a été franchi

Vérifier la signature

Chaque livraison inclut un en-tête X-Emini-Signature : un HMAC-SHA256 du corps brut de la requête, calculé avec votre secret.

Node.jstypescript
import crypto from "node:crypto";

function isValid(rawBody: string, signature: string, secret: string): boolean {
  const expected = crypto.createHmac("sha256", secret).update(rawBody).digest("hex");
  return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
}

Gérer les webhooks

bash
GET /v1/webhooks                              # lister
DELETE /v1/webhooks/{webhook_id}              # desactiver
GET /v1/webhooks/{webhook_id}/deliveries      # historique des livraisons

Alternative : sondage

Les webhooks sont optionnels — GET /v1/jobs/{job_id} reste toujours disponible pour sonder activement l'état d'un job (voir le guide Vidéo).