How To
Start a Run
You’ve defined your workflow, and the final step is to trigger the endpoint!
There are two main ways to start your workflow:
1. Using client.trigger
(Recommended)
This feature is not yet available in workflow-py. See our Roadmap for feature parity plans and Changelog for updates.
We recommend using client.trigger
to start your workflow.
2. Sending an HTTP Request
This approach is recommended for quick testing via curl.
If you’ve secured your endpoint with signing keys, only the trigger
methid will work. Direct calls to the endpoint (e.g., via curl
or fetch
) will not be accepted.
Accessing Payload and Headers
When you call the endpoint, the payload and headers you send will be accessible in the context:
- The payload is available in the
context.requestPayload
field. - The headers are available in the
context.headers
field.
For more details, refer to the documentation on the Context object.