Web monitoring

POST Parameters

NameTypeDescription
destination
Required
StringThe target URL.
name
Required
StringThe name of the action.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to WEB.
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.
timeoutIntegerThe timeout in seconds.
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.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
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 or VAR_NOT_CONTAINS.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "Check http://buddy.works/ status",
"type": "WEB",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"login": "owner@buddy.works",
"password": "secure!TPR+DWaI7z47j6Ns4kkSJQ==",
"port": "8080",
"destination": "http://buddy.works/",
"post_data": "{\r\n\"test\": \"ok\"\r\n}",
"headers": [
{
"name": "User-Agent",
"value": "Buddy"
},
{
"name": "myHeader",
"value": "myHeaderValue"
}
],
"text_existence": true,
"text": "ok"
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/860",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/860/edit",
"id": 860,
"name": "Check http://buddy.works/ status",
"type": "WEB",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"last_execution_status": "INITIAL",
"run_only_on_first_failure": false,
"login": "owner@buddy.works",
"port": "8080",
"headers": [
{
"name": "User-Agent",
"value": "Buddy"
},
{
"name": "myHeader",
"value": "myHeaderValue"
}
],
"post_data": "{\r\n\"test\": \"ok\"\r\n}",
"destination": "http://buddy.works/",
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "Live mirror",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}