Web monitoring
Learn more about:
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to WEB . |
destination Required | String | The target URL. |
headers | Header[] | The headers that will be sent with the request. |
login | String | The username required to connect to the server. |
password | String | The password required to connect to the server. |
port | String | The port for the connection. |
post_data | String | The data that will be sent. |
text | String | The text that should or should not be present in the response. |
text_existence | Boolean | Defines 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",
"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",
"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",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}
Last modified on November 16, 2022