Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

ExecutionNotification

Update Execution Notification

Update partial Execution Notification information (name, enabled state)

patch/executionNotifications/{id}

Path parameters

idstring required

Execution Notification identifier

Headers

If-Matchstring

If-Match header according to http/1.1 spec section 14.24

Request body

idstring

Unique identifier

created_timeinteger

Creation time, epoch milliseconds GMT

created_by_idstring

Creation User identifier

last_updated_timeinteger

Last update time, epoch milliseconds GMT

last_updated_by_idstring

Last updated User identifier

workspace_idstring

Associated Organization identifier

enabledboolean

Enabled state, true to use Notification on Plan Execution

notification_type'webhook' | 'email'

Notification type

lifecycle_triggersstring[]

Triggering events in Plan Execution lifecycle [pre_execution, post_execution]

execution_outcome_triggersstring[]

Triggering Plan Execution outcomes [on_success, on_failure]

execution_contingentboolean

If true, Plan Execution continues if notification successful (only for pre_execution)

strict_tlsboolean

If true, require strict validation of all TLS connections

namestring

Display name

target_urlstring

Endpoint URL to receive POST payload, starting with protocol (e.g. https://)

target_emailstring

Email address to receive execution notification

plan_idsstring[]

Plans associated with Notification, if empty, applies to all Workspace Plans

Response

Updated Execution Notification

idstring

Unique identifier

created_timeinteger

Creation time, epoch milliseconds GMT

created_by_idstring

Creation User identifier

last_updated_timeinteger

Last update time, epoch milliseconds GMT

last_updated_by_idstring

Last updated User identifier

workspace_idstring

Associated Organization identifier

enabledboolean

Enabled state, true to use Notification on Plan Execution

notification_type'webhook' | 'email'

Notification type

lifecycle_triggersstring[]

Triggering events in Plan Execution lifecycle [pre_execution, post_execution]

execution_outcome_triggersstring[]

Triggering Plan Execution outcomes [on_success, on_failure]

execution_contingentboolean

If true, Plan Execution continues if notification successful (only for pre_execution)

strict_tlsboolean

If true, require strict validation of all TLS connections

namestring

Display name

target_urlstring

Endpoint URL to receive POST payload, starting with protocol (e.g. https://)

target_emailstring

Email address to receive execution notification

plan_idsstring[]

Plans associated with Notification, if empty, applies to all Workspace Plans