ExecutionNotification

Update Execution Notification

Changed on

Update partial Execution Notification information. Notification type, tags and plan associations are fixed at creation and are ignored here.

patch/executionNotifications/{id}

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/executionNotifications/{id}
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

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. Defaults to true

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). Defaults to false

strict_tlsboolean

If true, require strict validation of all TLS connections. Defaults to true

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. Defaults to true

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). Defaults to false

strict_tlsboolean

If true, require strict validation of all TLS connections. Defaults to true

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

Changes

  • d0a5100df4c1Revision changes
    • info

      added the new optional request property

    • info

      the request property default value true was removed

    • info

      the request property default value false was removed

    • info

      the request property default value true was removed

    • info

      added the optional property to the response with the status

    • info

      the response's property default value true was removed for the status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value true was removed for the status