Hoe krijg ik een webhook als een take klaar is?
Op deze pagina
Een webhook stuurt een gebeurtenis naar je URL als een take klaar is, een take is gekozen of er een nieuwe versie komt, zodat je niet hoeft te pollen. Webhooks stel je in via de API, door een producer of owner. Er is geen scherm voor in de studio.
Abonneren #
Stuur een POST naar /v1/workspaces/{ws}/webhooks met je url en de events die je wilt, of ["*"] voor alles. Het antwoord bevat één keer een secret: bewaar het, want je hebt het nodig om elke levering te controleren. De URL moet een http- of https-adres op een openbare host zijn. Je hebt een sleutel nodig: zie hoe je een API-sleutel krijgt. Het verzoek staat in de docs onder subscribe.
Gebeurtenissen #
Er zijn vier gebeurtenissen: generation.succeeded, generation.failed, take.selected en asset_version.created. Gebeurtenissen over takes in het private sketchbook van iemand worden nooit verstuurd. De velden van elk staan in the data of each event.
Controleren en antwoorden #
Elke levering heeft een x-fs-signature-header: sha256= plus de hex-HMAC-SHA256 van de ruwe body, met je secret als sleutel. Wijs een levering af waarvan de handtekening niet klopt; de code staat in check the signature.
Antwoord snel met een willekeurige 2xx-status. Een 5xx, een 429, een timeout of een netwerkfout wordt met backoff opnieuw geprobeerd, tot 8 pogingen. Elke andere 4xx beëindigt de levering. Een levering kan meer dan eens aankomen, gebruik dus x-fs-delivery om een gebeurtenis over te slaan die je al hebt verwerkt.