Flows
Define a moment to guard
Beta. The request and response shapes may still change.
Define a moment you want to guard - signup, checkout, password reset - and reference the recipes that run there. The flow identifier is what you pass as flow_id to Evaluate a flow.
Every recipe referenced here must exist. Only recipes in LIVE or SHADOW status take part in an evaluation; a DRAFT or INACTIVE one is referenced by the flow and reported on by neither.
POST
Create a flow
A flow represents a moment in your product - signup, checkout, password reset, a payout request - and references the recipes that run there.
The identifier you get back is what you pass as
flow_id to Evaluate a flow. That call answers with the most severe verdict and action across the recipes that ran, plus each recipe’s own result.
Every recipe referenced here must exist; one that doesn’t is refused against the recipes field. Only LIVE and SHADOW recipes take part in an evaluation, so a flow can safely reference a DRAFT recipe you are still assembling.
One flow per moment, not per rule
Keep flows coarse and recipes specific. A flow is a stable identifier compiled into your product, so changing what a moment checks should mean swapping recipes inside the flow, not asking your application to call a differentflow_id.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json