Start a workflow from a webhook
Give another system the workflow's address and secret; each POST with JSON starts a run, and an Idempotency-Key stops duplicates.
Account administrators: «Owner», «Super administrator» and «Administrator». The rest of the team can open public workflows and their history, but can't change or launch them.
Workflows isn't open in Filmo yet: the sidebar shows it as coming soon and its pages can't be opened. This article describes how it works once it's available in your account.
Sometimes the starting point is outside Filmo: a form on your website, a booking tool or a script of your own.
The gives the workflow its own address. When another system sends a POST request with JSON to it, together with the workflow's secret, the workflow starts with the request body as its data.
Connect another system
- Choose the «Webhook» trigger In the trigger block, or in «Configure a trigger» when you create the workflow.
- Copy the address and the secret Use «Copy endpoint» and «Copy secret». Both were created with the workflow and don't change when you publish.
- Set up the sender It sends the data as JSON and the secret in the X-Webhook-Secret header, or as Authorization: Bearer.
- Publish and activate The address only accepts requests while the workflow is in .
- Send a first request It's a real . Check the result in the «Runs» tab.
Warning: Treat the secret like a password: with it and the address, anyone can start the workflow. Any team member who can open a public workflow can also see them, so make the workflow private if that matters.
Avoid duplicate runs
If the sender may send the same request twice, have it add an header. A second delivery with the same key returns the run already created instead of creating another. Without that header, every delivery creates a run.
Limits
- The request body can be up to 256 KB.
- Each address accepts up to 60 requests per minute.
- An Idempotency-Key can be up to 255 characters.
What the address answers
| Response | When |
|---|---|
| 202, with the run's identifier | The request was accepted and queued. |
| 200, with duplicate: true | The Idempotency-Key was already used; it returns the existing run. |
| 401 | The secret is missing or doesn't match. |
| 404 | The address doesn't exist, the trigger is no longer a webhook, or the workflow isn't in «Live». |
| 409 | The workflow has no published version. |
| 400 | The body isn't JSON, or the Idempotency-Key is longer than 255 characters. |
| 413 | The body is larger than 256 KB. |
| 429 | More than 60 requests in a minute to the same address. |
Good to know
- If you change the trigger to another type, or pause the workflow, the address stops accepting requests.
- To launch a workflow from your own software with an API key instead, see the public API in Run a workflow manually.