HTTP Request

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
notification_url
Required
StringThe target URL.
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 HTTP.
portStringThe port for the connection.
contentStringThe content of the request.
headersHeader[]The headers that will be sent with the request.
timeoutIntegerThe HTTP request timeout in seconds. Available values between 0-600.
loginStringThe username required to connect to the server.
passwordStringThe password required to connect to the server.
run_only_on_first_failureBooleanDefines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
variablesVariable []The list of variables defined for this action.
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": "HTTP Action",
"type": "HTTP",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"variables": [
{
"key": "ftp_login",
"value": "userLogin123",
"description": "The name of user to FTP.",
"encrypted": false,
"settable": false
},
{
"key": "ftp_password",
"value": "secure!14ivLMxPgv7TX6c9+ITX/g==",
"description": "The password for ftp.",
"encrypted": true
}
]
"content": "Pipeline executed successfully!",
"notification_url": "http://mywebserver.io",
"port": "1234",
"method": "PATCH",
"timeout": 120,
"headers": [
{
"name": "User-Agent",
"value": "Buddy"
}
}

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/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",
"trigger_condition": "ALWAYS",
"variables": [
{
"key": "ftp_login",
"value": "userLogin123",
"description": "The name of user to FTP.",
"encrypted": false,
"settable": false
},
{
"key": "ftp_password",
"value": "secure!14ivLMxPgv7TX6c9+ITX/g==",
"description": "The password for ftp.",
"encrypted": true
}
]
"last_execution_status": "INITIAL",
"content": "Pipeline executed successfully!",
"run_only_on_first_failure": false,
"notification_url": "http://mywebserver.io",
"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",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}