Heroku

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to HEROKU.
application_name
Required
StringThe name of the application.
integration
Required
StringThe integration.
use_custom_gitignoreBooleanWhen set to true the push will ignore paths listed in .gitignore file.
isolated**BooleanWhen set to true, action will push only repository files (without artifacts).
deployment_excludesString[]The paths and/or files that will be left out during the push. Only works hen use_custom_gitignoreis set to true.
deployment_includesString[]The exceptions from the ignore patterns set in deployment_excludes.
without_forceBooleanDefines whether the --force flag should be used when invoking the git push command or not.

Example

Request

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

JSON

{
"name": "Push to Your Repo",
"type": "HEROKU",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"use_custom_gitignore": true,
"isolated": true,
"integration": {
"id": 33
},
"application_name": "AppName",
"deployment_excludes": [
"/tmp/",
"*.log"
],
"deployment_includes": [
"/assets/style",
"/tmp/file.txt"
],
}

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": "Deploy application to Heroku",
"type": "HEROKU",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"last_execution_status": "INITIAL",
"application_name": "AppName",
"use_custom_gitignore": true,
"isolated": true,
"integration": {
"url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
"html_url": "https://app.buddy.works/my-id",
"id": 1
},
"deployment_excludes": [
"/tmp/",
"*.log"
],
"deployment_includes": [
"/assets/style",
"/tmp/file.txt"
],
"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"
}
}