Filmsquare AyudaDocs

Conecta tus herramientas

¿Cómo recibo un webhook cuando una toma está lista?

Actualizado .md

En esta página
  1. Suscríbete
  2. Eventos
  3. Comprueba y responde

Un webhook envía un evento a tu URL cuando una toma termina, se elige una toma o llega una versión nueva, así que no hace falta consultar cada poco. Los webhooks los configura por la API un producer o un owner. No hay ninguna pantalla para ellos en el estudio.

Suscríbete #

Envía un POST a /v1/workspaces/{ws}/webhooks con tu url y los events que quieras, o ["*"] para todos. La respuesta contiene un secret una sola vez: guárdalo, porque lo necesitas para comprobar cada entrega. La URL debe ser una dirección http o https en un host público. Necesitas una clave: consulta cómo obtener una clave de API. La solicitud está en la documentación, en subscribe.

Eventos #

Existen cuatro eventos: generation.succeeded, generation.failed, take.selected y asset_version.created. Los eventos sobre tomas del sketchbook privado de una persona nunca se envían. Los campos de cada uno están en the data of each event.

Comprueba y responde #

Cada entrega lleva una cabecera x-fs-signature: sha256= más el HMAC-SHA256 en hexadecimal del cuerpo sin procesar, con tu secret como clave. Rechaza una entrega cuya firma no coincida; el código está en check the signature.

Responde con cualquier estado 2xx, y rápido. Un 5xx, un 429, un tiempo de espera agotado o un error de red se reintenta con espera creciente, hasta 8 intentos. Cualquier otro 4xx pone fin a la entrega. Una entrega puede llegar más de una vez, así que usa x-fs-delivery para omitir un evento que ya has tratado.

Escríbenos