POST
/
api
/
flow_run_notification_policies
/

Headers

x-prefect-api-version
string

Body

application/json
is_active
boolean
default: true

Whether the policy is currently active

state_names
string[]
required

The flow run states that trigger notifications

tags
string[]
required

The flow run tags that trigger notifications (set [] to disable)

block_document_id
string
required

The 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'

Response

201 - application/json
id
string
created
string | null
updated
string | null
is_active
boolean
default: true

Whether the policy is currently active

state_names
string[]
required

The flow run states that trigger notifications

tags
string[]
required

The flow run tags that trigger notifications (set [] to disable)

block_document_id
string
required

The 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'