Web Monitoring with YAML

YAML parameters for Web Monitoring

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to WEB.
destination
Required
StringThe target URL.
headersHeader[]The headers that will be sent with the request.
loginStringThe username required to connect to the server.
passwordStringThe password required to connect to the server.
portStringThe port for the connection.
post_dataStringThe data that will be sent.
textStringThe text that should or should not be present in the response.
text_existenceBooleanDefines whether the response should or should not contain given text. If set, the text argument is required.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS.
trigger_condition_pathsString[]Required when trigger_condition is set to ON_CHANGE_AT_PATH.
trigger_variable_keyStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the name of the desired variable.
trigger_variable_valueStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the value of the desired variable which will be compared with its current value.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.

YAML example for Web Monitoring

actions:
- action: "Check https://buddy.works/status status"
type: "WEB"
login: "owner@buddy.works"
password: "supersecretpassword"
headers:
- name: "User-Agent"
value: "Buddy"
- name: "Content-Type"
value: "application/json"
post_data: "{\r\n \"test\": true\r\n}"
text: "fail"
text_existence: true
destination: "https://buddy.works/status"