Shopify
Learn more about:
POST Parameters
| Name | Type | Description |
|---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to SHOPIFY. |
theme Required | Integer | The ID of the Shopify theme. |
theme_name Required | String | The name of the Shopify theme. |
integration Required | Integration | The integration. |
| deployment_excludes | String[] | The paths and/or files that will be left out during the deployment. |
| deployment_includes | String[] | The exceptions from the ignore patterns set in deployment_excludes. |
| input_type | String | Defines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS. |
Example
Request
text
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
json
{
"name": "Push to Shopify",
"type": "SHOPIFY",
"input_type": "SCM_REPOSITORY",
"trigger_time": "ON_EVERY_EXECUTION",
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"theme": "MyTheme",
"deployment_excludes": [
"/tmp/",
"*.log"
],
"deployment_includes": [
"/assets/style",
"/tmp/file.txt"
],
}
Sample Response
HTTP
text
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
json
{
"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",
"hash_id": "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"
}
}
Last modified on November 16, 2022