Web monitoring

POST Parameters

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

NameTypeDescription
name
Required
StringThe name 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.

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",
"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"
}
}