Web monitoring

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
domainrequired string
The workspace domain.
pipeline_idrequired integer
The numerical ID of the desired pipeline.
project_namerequired string
The name ID of the project.
POST PARAMETERS
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to WEB.
destinationrequired string
The target URL.
headersoptional Header[]
The headers that will be sent with the request.
loginoptional string
The username required to connect to the server.
passwordoptional string
The password required to connect to the server.
portoptional string
The port for the connection.
post_dataoptional string
The data that will be sent.
textoptional string
The text that should or should not be present in the response.
text_existenceoptional boolean
Defines whether the response should or should not contain given text. If set, the text argument is required.

Last modified on Oct 7, 2024

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "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"
}'
EXAMPLE RESPONSE
{ "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" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999