Heroku CLI

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to HEROKU_CLI.
execute_commands
Required
String[]The commands that will be executed.
integration
Required
IntegrationThe integration.
application_nameStringThe name of the application.
shellStringThe name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.
setup_commandsString[]The command that will be executed only on the first run.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions

JSON

{
"name": "Execute commands on Heroku",
"type": "HEROKU_CLI",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"variables": [
{
"key": "appName",
"value": "my-app"
}
],
"setup_commands": [
"apt-get update && apt-get -y install git"
],
"execute_commands": [
"heroku run ls -al --app $appName"
],
"shell": "SH",
"application_name": "AppName",
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
}
}

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/1/actions/1",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1/action/1/edit",
"id": 1,
"name": "Execute commands on Heroku",
"type": "HEROKU_CLI",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"variables": [
{
"key": "appName",
"value": "my-app"
}
],
"last_execution_status": "INITIAL",
"setup_commands": [
"apt-get update && apt-get -y install git"
],
"execute_commands": [
"heroku run ls -al --app $appName"
],
"shell": "SH",
"application_name": "AppName",
"integration": {
"url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
"html_url": "https://app.buddy.works/my-id",
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1",
"id": 1,
"name": "test server",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}