Netlify

POST Parameters

List with common parameters for all Buddy actions

NameTypeDescription
application_name
Required		StringThe name of the Netlify application.
type
Required		StringThe type of the action. Should be set to NETLIFY.
integration
Required		IntegrationThe integration.
execute_commands
Required		String[]Commands that will be executed.
site_id
Required		StringThe API ID in the site details.

Example

Request

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

JSON

{
  "name": "Deploy to apk-42707",
  "type": "NETLIFY",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_condition": "ALWAYS",
  "application_name": "apk-42707",
  "site_id": "70225fg3-9sc1-17c6-98dc-ef367123f12d9"
  "execute_commands": [
    "netlify deploy --dir=${netlify_dir}"
  ],
  "variables": [
   {
      "key": "netlify_dir",
      "value": "directory_name"
   }
  ],
  "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/2/actions/1",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/1/edit",
  "id": 1,
   "name": "Deploy to apk-42707",
  "type": "NETLIFY",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_condition": "ALWAYS",
  "application_name": "apk-42707",
  "site_id": "70225fg3-9sc1-17c6-98dc-ef367123f12d9"
  "execute_commands": [
    "netlify deploy --dir=${netlify_dir}"
  ],
  "variables": [
  {
     "key": "netlify_dir",
     "value": "directory_name"
  },
  ]"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/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"
  }
}
Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.