HTTP Request

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

Hint

List with common parameters for all Buddy 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 HTTP.

notification_urlrequired string

The target URL.

methodrequired string

The desired HTTP method. Available values are GET, POST, PUT, PATCH, or DELETE.

portstring

The port for the connection.

contentstring

The content of the request.

headersHeader[]

The headers that will be sent with the request.

loginstring

The username required to connect to the server.

passwordstring

The password required to connect to the server.

Last modified on Oct 7, 2024

Honeybadger JMeter CLI

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": "HTTP Action",
  "type": "HTTP",
  "trigger_time": "ON_EVERY_EXECUTION",
  "variables": [
    {
      "key": "endpointUrl",
      "value": "http://mywebserver.io"
    }
  ],
  "content": "Pipeline executed successfully!",
  "notification_url": "$endpointUrl",
  "port": "1234",
  "method": "PATCH",
  "timeout": 120,
  "headers": [
    {
      "name": "User-Agent",
      "value": "Buddy"
    }
  ]
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
  "id": 2,
  "name": "HTTP Action",
  "type": "HTTP",
  "trigger_time": "ON_EVERY_EXECUTION",
  "variables": [
    {
      "key": "endpointUrl",
      "value": "http://mywebserver.io"
    }
  ],
  "last_execution_status": "INITIAL",
  "content": "Pipeline executed successfully!",
  "notification_url": "$endpointUrl",
  "port": "1234",
  "method": "PATCH",
  "headers": [
    {
      "name": "User-Agent",
      "value": "Buddy"
    }
  ],
  "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