Shopify

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.

themerequiredinteger

The ID of the Shopify theme.

theme_namerequiredstring

The name of the Shopify theme.

integrationrequiredIntegration

The integration.

deployment_excludesstring[]

The paths and/or files that will be left out during the deployment.

deployment_includesstring[]

The exceptions from the ignore patterns set in deployment_excludes.

input_typestring

Defines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.

Last modified on Jan 19, 2026

Set variables Shopify CLI

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": "Push to Shopify",
  "type": "SHOPIFY",
  "input_type": "SCM_REPOSITORY",
  "trigger_time": "ON_EVERY_EXECUTION",
  "integration": {
    "identifier": "5ddb7c180fb38be67bd78a88a"
  },
  "theme": "MyTheme",
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ]
}'

Response

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": "Push to Shopify",
  "type": "SHOPIFY",
  "input_type": "SCM_REPOSITORY",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "theme": "MyTheme",
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ],
  "integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
    "html_url": "https://app.buddy.works/my-id",
    "identifier": "5ddb7c180fb38be67bd78a88a"
  },
  "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