Flow Run Notification Policies
Read Flow Run Notification Policies
Query for flow run notification policies.
POST
/
api
/
flow_run_notification_policies
/
filter
Headers
x-prefect-api-version
string
Body
application/json
flow_run_notification_policy_filter
object
Filter FlowRunNotificationPolicies.
offset
integer
default: 0limit
integer
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
200 - application/json
id
string
created
string | null
updated
string | null
is_active
boolean
default: trueWhether the policy is currently active
state_names
string[]
requiredThe flow run states that trigger notifications
tags
string[]
requiredThe flow run tags that trigger notifications (set [] to disable)
block_document_id
string
requiredThe block document ID used for sending notifications
message_template
string | null
A templatable notification message. Use {braces} to add variables. Valid variables include: 'flow_id', 'flow_name', 'flow_run_id', 'flow_run_name', 'flow_run_notification_policy_id', 'flow_run_parameters', 'flow_run_state_message', 'flow_run_state_name', 'flow_run_state_timestamp', 'flow_run_state_type', 'flow_run_url'
Was this page helpful?