Shopify CLI

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to SHOPIFY_THEMEKIT_CLI.
execute_commands
Required
String[]The commands that will be executed.
integration
Required
IntegrationThe integration.
shellStringThe 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.

Example

Request

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

JSON

{
"name": "Shopify theme",
"type": "SHOPIFY_THEMEKIT_CLI",
"trigger_condition": "ALWAYS",
"integration": {
"hash_id": "5ed4fe6146e03e110be748b7"
},
"setup_commands": [
"apt-get update && apt-get -y install git"
],
"execute_commands": [
"theme deploy"
],
"shell": "SH"
}

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/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"
],
"trigger_condition": "ALWAYS",
"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",
"trigger_mode": "MANUAL",
"ref_name": "master",
"ref_type": "BRANCH",
"last_execution_status": "INITIAL",
"last_execution_revision": "SUCCESSFUL"
}
}