Theme Kit CLI

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy 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 SHOPIFY_THEMEKIT_CLI.

execute_commandsrequired string[]

The commands that will be executed.

integrationrequired Integration

The integration.

shellstring

The 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.

Last modified on Sep 27, 2024

Terraform CLI Transfer to a sandbox

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": "Shopify theme",
  "type": "SHOPIFY_THEMEKIT_CLI",
  "integration": {
    "hash_id": "5ed4fe6146e03e110be748b7"
  },
  "setup_commands": [
    "apt-get update && apt-get -y install git"
  ],
  "execute_commands": [
    "theme deploy"
  ],
  "shell": "SH"
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
  "id": 2,
  "name": "Shopify theme",
  "type": "SHOPIFY_THEMEKIT_CLI",
  "last_execution_status": "INITIAL",
  "disabled": false,
  "integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
    "html_url": "https://app.dev.io/my-id",
    "hash_id": "5ed4fe6146e03e110be748b7"
  },
  "setup_commands": [
    "apt-get update && apt-get -y install git"
  ],
  "execute_commands": [
    "theme deploy"
  ],
  "ignore_errors": false,
  "shell": "SH",
  "run_next_parallel": false,
  "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": "INITIAL",
    "last_execution_revision": "SUCCESSFUL"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999