Webhooks
Webhook notification settings
This node uses the key urls
as a default prefix if not given a map.
Types
- Sequence of Map
- Sequence of Sequence of Secure
- Sequence of Secure
- Sequence of Boolean
- Map
- Secure
- Boolean
Keys
If given a map, the following keys are supported:
urls
— Webhook URLs to notify (type: sequence of secure, or secure)on_start
— Notification frequency (type: enum (string), known values:always
,never
,change
)on_cancel
— Notification frequency (type: enum (string), known values:always
,never
,change
)on_error
— Notification frequency (type: enum (string), known values:always
,never
,change
)if
— Condition to determine if a build, stage, or job should be run, a config source imported, or a notification sent (type: string, e.g.:branch = master
, see: Conditional Builds, Stages, and Jobs, Conditional Notifications)on_success
— Notification frequency (type: enum (string), known values:always
,never
,change
)on_failure
— Notification frequency (type: enum (string), known values:always
,never
,change
)enabled
— Whether to enable these notifications (type: boolean)disabled
— Whether to disable these notifications (type: boolean)
Examples
webhooks:
- urls:
- secure: encrypted string
on_start: always
on_cancel: always
- urls:
secure: encrypted string
webhooks:
- secure: encrypted string
webhooks:
- true
webhooks:
urls:
- secure: encrypted string
on_start: always
on_cancel: always
webhooks:
secure: encrypted string
webhooks: true