Theme Kit CLI

View as Markdown

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

Info

List with common parameters for all Buddy actions

Request

URL PARAMETERS

workspacerequiredstring

The workspace name.

pipeline_idrequiredinteger

The numerical ID of the desired pipeline.

project_namerequiredstring

The name ID of the project.

POST PARAMETERS

namerequiredstring

The name of the action.

typerequiredstring

The type of the action. Should be set to SHOPIFY_THEMEKIT_CLI.

execute_commandsrequiredstring[]

The commands that will be executed.

integrationrequiredIntegration

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 Jan 19, 2026

Terraform CLI Trigger pipeline

Request example


curl -X POST "https://api.buddy.works/workspaces/:workspace/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": {
    "identifier": "5ed4fe6146e03e110be748b7"
  },
  "setup_commands": [
    "apt-get update && apt-get -y install git"
  ],
  "execute_commands": [
    "theme deploy"
  ],
  "shell": "SH"
}'

Response

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",
    "identifier": "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