Heroku

  • 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 HEROKU.
application_namerequired string
The name of the application.
integrationrequired Integration
The integration.
use_custom_gitignoreoptional boolean
When set to true the push will ignore paths listed in .gitignore file.
isolatedoptional boolean
When set to true, action will push only repository files (without artifacts).
deployment_excludesoptional string[]
The paths and/or files that will be left out during the push. Only works when use_custom_gitignore is set to true.
deployment_includesoptional string[]
The exceptions from the ignore patterns set in deployment_excludes.
without_forceoptional boolean
Defines whether the --force flag should be used when invoking the git push command or not.

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": "Push to Your Repo",
  "type": "HEROKU",
  "trigger_time": "ON_EVERY_EXECUTION",
  "use_custom_gitignore": true,
  "isolated": true,
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "application_name": "AppName",
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ]
}'
EXAMPLE RESPONSE
{ "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", "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", "hash_id": "5ddb7c180fb38be67bd78a88a" }, "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", "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