Wie bekomme ich einen Webhook, wenn ein Take fertig ist?
Auf dieser Seite
Ein Webhook sendet ein Ereignis an deine URL, wenn ein Take fertig wird, ein Take ausgewählt wird oder eine neue Version eintrifft, sodass du nicht ständig nachfragen musst. Webhooks werden von einem Producer oder Owner über die API eingerichtet. Im Studio gibt es dafür keine Oberfläche.
Abonnieren #
Sende einen POST an /v1/workspaces/{ws}/webhooks mit deiner url und den gewünschten events, oder ["*"] für alle. Die Antwort enthält einmal ein secret: Bewahre es auf, denn du brauchst es, um jede Zustellung zu prüfen. Die URL muss eine http- oder https-Adresse auf einem öffentlichen Host sein. Du brauchst einen Key: siehe so bekommst du einen API-Key. Die Anfrage steht in den Docs unter subscribe.
Ereignisse #
Es gibt vier Ereignisse: generation.succeeded, generation.failed, take.selected und asset_version.created. Ereignisse zu Takes im privaten Sketchbook einer Person werden nie gesendet. Die Felder jedes Ereignisses stehen in the data of each event.
Prüfen und antworten #
Jede Zustellung trägt einen x-fs-signature-Header: sha256= plus der Hex-HMAC-SHA256 des Rohinhalts, mit deinem Secret als Schlüssel. Weise eine Zustellung ab, deren Signatur nicht passt; den Code findest du unter check the signature.
Antworte schnell mit einem beliebigen 2xx-Status. Ein 5xx, ein 429, ein Timeout oder ein Netzwerkfehler wird mit Backoff wiederholt, bis zu 8 Versuche. Jedes andere 4xx beendet die Zustellung. Eine Zustellung kann mehr als einmal eintreffen, nutze also x-fs-delivery, um ein bereits verarbeitetes Ereignis zu überspringen.