Como recebo um webhook quando um take está pronto?
Nesta página
Um webhook envia um evento para a sua URL quando um take termina, um take é escolhido ou chega uma versão nova, para você não precisar consultar de tempos em tempos. Webhooks são configurados pela API por um(a) produtor(a) ou proprietário(a). Não há tela para eles no estúdio.
Inscreva-se #
Envie um POST para /v1/workspaces/{ws}/webhooks com a sua url e os events que você quer, ou ["*"] para todos. A
resposta traz um secret uma vez: guarde-o, porque você precisa dele para conferir cada entrega. A URL precisa ser um
endereço http ou https num host público. Você precisa de uma chave: veja como obter uma chave de API.
O pedido está na documentação em inscrever-se.
Eventos #
Existem quatro eventos: generation.succeeded, generation.failed, take.selected e asset_version.created. Eventos sobre
takes no caderno de rascunhos (sketchbook) privado de uma pessoa nunca são enviados. Os campos de cada um estão em os dados
de cada evento.
Confira e responda #
Toda entrega traz um cabeçalho x-fs-signature: sha256= mais o HMAC-SHA256 em hexadecimal do corpo bruto, com a chave do
seu secret. Rejeite uma entrega cuja assinatura não bata; o código está em confira a assinatura.
Responda com qualquer status 2xx, rapidamente. Um 5xx, um 429, um timeout ou um erro de rede é repetido com backoff,
até 8 tentativas. Qualquer outro 4xx encerra a entrega. Uma entrega pode chegar mais de uma vez, então use
x-fs-delivery para pular um evento que você já tratou.