| [ Web Proxy ] |
| Viewing: https://docs.getmesa.com/for-developers/admin-api | [Back] [Original] |
Returns a list of automations for a store, sorted by most recently created first.
![[]](https://docs.getmesa.com/~gitbook/image?url=https%3A%2F%2F3425906282-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1H6u1HQc3Iew7ATmmiCi%252Ficon%252FwQi97cmrTrjuixmWEXTB%252Ficon.png%3Falt%3Dmedia%26token%3Da62c4425-2909-4829-aae5-8eb8950793bc&width=32&dpr=3&quality=100&sign=966a9d5d&sv=2){kind=link}
{{api_key}}{"automations":[{"uuid":"my-store","created_by":"","key":"etsy_order_send_to_google_sheets","name":"Send Etsy orders to Google Sheets","version":"1.0.0","template":"etsy/order/send_to_google_sheets","description":"Consolidate your Etsy orders in Google Sheets for real-time tracking and improved order management. This template will automatically send Etsy order details to a Google Sheets spreadsheet when a customer completes an order on Etsy.","video":"","is_premium":false,"tags":[],"source":"","destination":"","enabled":false,"did_complete":false,"logging":true,"debug":false,"setup":"incomplete","seconds":135,"notifications":{"enabled":false,"emails":["example@theshoppad.com"]},"_id":"65f1fdbbb54ac273e806026b","created_at":"Mar 13 2020","updated_at":"Mar 13 2024"}]}Successful response
GET /admin/{uuid}/automations.json HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: */*
Content-Length: 776
{
"automations": [
{
"uuid": "my-store",
"created_by": "",
"key": "etsy_order_send_to_google_sheets",
"name": "Send Etsy orders to Google Sheets",
"version": "1.0.0",
"template": "etsy/order/send_to_google_sheets",
"description": "Consolidate your Etsy orders in Google Sheets for real-time tracking and improved order management. This template will automatically send Etsy order details to a Google Sheets spreadsheet when a customer completes an order on Etsy.",
"video": "",
"is_premium": false,
"tags": [],
"source": "",
"destination": "",
"enabled": false,
"did_complete": false,
"logging": true,
"debug": false,
"setup": "incomplete",
"seconds": 135,
"notifications": {
"enabled": false,
"emails": [
"example@theshoppad.com"
]
},
"_id": "65f1fdbbb54ac273e806026b",
"created_at": "Mar 13 2020",
"updated_at": "Mar 13 2024"
}
]
}Successful response
{{api_key}}application/jsonSuccessful response
GET /admin/{uuid}/automations/{automation_key}.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
Updates the Inputs, Outputs, Credentials and Storage for an automation. Updating scripts requires separate calls to the Script POST endpoing for each script.
{{api_key}}{"key":"","name":"","config":{"inputs":[],"outputs":[],"secrets":[],"storage":[],"files":[],"overwrite":false}}Successful response
POST /admin/{uuid}/automations.json HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: */*
Content-Length: 111
{
"key": "",
"name": "",
"config": {
"inputs": [],
"outputs": [],
"secrets": [],
"storage": [],
"files": [],
"overwrite": false
}
}Successful response
new_workflow_1{{api_key}}Successful response
DELETE /admin/{uuid}/automations/{automation_key}.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
Returns a list of all Credential names. Credential values are not available via the Admin API.
{{api_key}}Successful response
GET /admin/{uuid}/{automation_key}/credentials.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
new_workflow_1{{api_key}}{"secret":{"key":"mysecret","value":"myvalue"}}Successful response
POST /admin/{uuid}/{automation_key}/credentials.json HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"secret": {
"key": "mysecret",
"value": "myvalue"
}
}Successful response
new_workflow_1{{api_key}}{"secret":{"value":"myvalue"}}Successful response
PUT /admin/{uuid}/{automation_key}/credentials/{credential_key}.json HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"secret": {
"value": "myvalue"
}
}Successful response
| Key | Description |
|---|---|
| {{uuid}} | Your store's unique identifier: {{uuid}}.myshopify.com. |
| {{automation_key}} | The automation's key. Example: shoppad/mesa-templates/shopify/draft-order/remove. |
| {{secret_key}} | The key of the Credential, which can be obtained from the Credentials tab of the Mesa Dashboard. |
new_workflow_1googlesheets_1{{api_key}}Successful response
DELETE /admin/{uuid}/{automation_key}/credentials/{credential_key}.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
Note: Storage has been deprecated in favor of Data by MESA. Returns a list of all Storage item names. To get a Storage value, call GET {{url}}/admin/{{uuid}}/storage/{{storage_name}}.json
new_workflow_1{{api_key}}Successful response
GET /admin/{uuid}/{automation_key}/storage.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
Note: Storage has been deprecated in favor of Data by MESA. Value parameter can be a string, an object, an array, or a boolean value.
new_workflow_1{{api_key}}{"storage":{"key":"{{storage_key}}","value":{"mykey":"myvalue"}}}Successful response
POST /admin/{uuid}/{automation_key}/storage.json HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"storage": {
"key": "{{storage_key}}",
"value": {
"mykey": "myvalue"
}
}
}Successful response
Note: Storage has been deprecated in favor of Data by MESA.
new_workflow_1storage_1{{api_key}}Successful response
GET /admin/{uuid}/{automation_key}/storage/{storage_key}.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
Note: Storage has been deprecated in favor of Data by MESA. Value parameter can be a string, an object, an array, or a boolean value.
new_workflow_1storage_1{{api_key}}{"storage":{"value":"mynewstringvalue"}}Successful response
PUT /admin/{uuid}/{automation_key}/storage/{storage_key}.json HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"storage": {
"value": "mynewstringvalue"
}
}Successful response
Note: Storage has been deprecated in favor of Data by MESA. Delete a Storage item.
new_workflow_1storage_1{{api_key}}Successful response
DELETE /admin/{uuid}/{automation_key}/storage/{storage_key}.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
Returns a list of all Scripts, including the Script code.
{{api_key}}Successful response
GET /admin/{uuid}/{automation_key}/scripts.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
new_workflow_1{{api_key}}{"script":{"filename":"myscript.js","code":"// Javascript goes here"}}Successful response
POST /admin/{uuid}/{automation_key}/scripts.json HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"script": {
"filename": "myscript.js",
"code": "// Javascript goes here"
}
}Successful response
{{api_key}}Successful response
DELETE /admin/{uuid}/{automation_key}/scripts.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
Trigger a test with a specific that is passed as the payload body parameter. To test an actual payload, consider running a test in the UI and replaying the task with POST replay.json.
new_workflow_1shopify_1{{api_key}}{"payload":{}}Successful response
POST /admin/{uuid}/{automation_key}/triggers/{trigger_key}/test.json HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}Successful response
Restart the execution of the workflow from a specific task. Data from all steps previous to this task in the original workflow run will be available.
To find the Task ID, click on a step in the Activity List > Request Details, and copy the last ID hash from the URL
65f3459357ca4e809608c8fb{{api_key}}Successful response
POST /admin/{uuid}/tasks/{task_id}/replay.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
{{api_key}}{"template":"shoppad/mesa-templates/tests/kitchen-sink","force":true}Successful response
POST /admin/{uuid}/templates/install.json HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"template": "shoppad/mesa-templates/tests/kitchen-sink",
"force": true
}Successful response
Returns a list of the most recent 50 log entries.
{{api_key}}Successful response
GET /admin/{uuid}/logs.json HTTP/1.1
Host: {{url}}
Accept: */*
Successful response
Last updated 10 months ago
| Web Proxy Viewer | New URL | Original Page |