Comment recevoir un webhook quand une prise est prête ?
Sur cette page
Un webhook envoie un événement à votre URL quand une prise se termine, quand une prise est choisie ou quand une nouvelle version arrive, pour que vous n'ayez pas à interroger l'API en boucle. Les webhooks se configurent via l'API par un producer ou un owner. Il n'existe pas d'écran pour eux dans le studio.
S'abonner #
Envoyez un POST à /v1/workspaces/{ws}/webhooks avec votre url et les events que vous voulez, ou ["*"] pour tous. La réponse contient un secret une seule fois : conservez-le, car il vous faut pour vérifier chaque envoi. L'URL doit être une adresse http ou https sur un hôte public. Il vous faut une clé : voir comment obtenir une clé d'API. La requête se trouve dans la documentation sous subscribe.
Événements #
Il existe quatre événements : generation.succeeded, generation.failed, take.selected et asset_version.created. Les événements concernant les prises du carnet de croquis privé d'une personne ne sont jamais envoyés. Les champs de chacun figurent dans the data of each event.
Vérifier et répondre #
Chaque envoi porte un en-tête x-fs-signature : sha256= suivi du HMAC-SHA256 hexadécimal du corps brut, calculé avec votre secret. Rejetez un envoi dont la signature ne correspond pas ; le code se trouve dans check the signature.
Répondez rapidement avec n'importe quel statut 2xx. Un 5xx, un 429, un délai dépassé ou une erreur réseau est réessayé avec un délai croissant, jusqu'à 8 tentatives. Tout autre 4xx met fin à l'envoi. Un envoi peut arriver plus d'une fois : utilisez x-fs-delivery pour ignorer un événement déjà traité.