Create Flow Run Notification Policy

Creates a new flow run notification policy.

For more information, see https://docs.prefect.io/v3/automate/events/automations-triggers#sending-notifications-with-automations.

Headers

x-prefect-api-version

string

Body

application/json

Data used by the Prefect REST API to create a flow run notification policy.

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

is_active

boolean

default:true

Whether the policy is currently active

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'

Example:

"Flow run {flow_run_name} with id {flow_run_id} entered state {flow_run_state_name}."

Response

201

application/json

Successful Response

An ORM representation of a flow run notification.

id

string

required

created

string | null

required

updated

string | null

required

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

is_active

boolean

default:true

Whether the policy is currently active

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'

Example:

"Flow run {flow_run_name} with id {flow_run_id} entered state {flow_run_state_name}."