Skip to main content
For AI agents: a documentation index is at /llms.txt. Every page is also available as markdown, just append .md to the URL.

​
Overview

A webhook sends a message to a URL you choose whenever one of your video projects completes, fails, or expires. Developers use webhooks so their systems react straight away instead of repeatedly checking Reap. For the payload format and code examples, see the Webhooks API reference.

​
Open Webhooks

Click your avatar in the top right, choose Settings, and open Webhooks. The counter at the top shows how many active webhooks you’re using and how many your plan allows, for example 0/5 active webhooks used.

​
Create A Webhook

1

Click Add Webhook

The Create a Webhook form opens.
2

Name it

Give the webhook a Name, for example Production Webhook.
3

Enter your endpoint

Enter the Webhook URL. It must start with https://.
4

Click Create Webhook

Reap sends a test request to your endpoint. Testing can take up to 5 seconds. You’ll see Webhook created successfully when it passes.
Your endpoint must reply with HTTP 200 and an empty body. Any other response is treated as a failure.

​
Manage Your Webhooks

Each webhook shows its Name, URL, and Status: If deliveries are failing, the number of consecutive failures appears next to the name. Use the actions on each row:
  • On/off switch: pause or resume the webhook. Turning it back on sends a test request.
  • View history: opens Dispatch History with the Time, Project, Trigger, Status, and Response of each delivery.
  • Edit: change the name or URL.
  • Delete: removes the webhook after you confirm.

​
When A Webhook Gets Disabled

After 5 consecutive failed deliveries, Reap disables the webhook automatically and emails you. A successful delivery resets the count. To fix it:
  1. Check View history to see the responses your endpoint returned.
  2. Fix your endpoint so it returns HTTP 200 with an empty body.
  3. Switch the webhook back on.

​
What To Know

  • Every active webhook receives notifications for every project in the studio. You can’t limit a webhook to certain project types.
  • To fetch a project’s results after a notification, use the API with an API key. See Create And Manage API Keys.