Chapter 516: Webhooks

Core Idea

When rendering on AWS Lambda, Remotion can send webhooks to notify you when the render ends, successfully or with failures. This page describes the webhook payloads and how to set up a webhook API endpoint.

Key Concepts

• Setup
• Response
• Validate Webhooks
• Example webhook endpoint (Express)
• Example webhook endpoint (Next.JS App Router)
• Example webhook endpoint (Next.JS Pages Router)
• Test your webhook endpoint
• See also

Code Examples

{
  "Content-Type": "application/json",
  "X-Remotion-Mode": "production" | "demo",
  "X-Remotion-Signature": "sha512=HASHED_SIGNATURE" | "NO_SECRET_PROVIDED",
  "X-Remotion-Status": "success" | "timeout" | "error",
}

• What it demonstrates: Usage pattern for Webhooks from the official docs.

Key Takeaways

1. Understand setup when working with Webhooks.
2. Understand response when working with Webhooks.
3. Understand validate webhooks when working with Webhooks.
4. Understand example webhook endpoint (express) when working with Webhooks.
5. Understand example webhook endpoint (next.js app router) when working with Webhooks.

Connects To

• api: related page in the Lambda (@remotion/lambda) section.
• Approuterwebhook: related page in the Lambda (@remotion/lambda) section.
• Authentication: related page in the Lambda (@remotion/lambda) section.