Mesa Admin API

The Mesa Admin API allows you to list, read, create and modify Storage and Secrets. All requests must be signed with your API key, which can be found in the bottom-right of the Mesa Dashboard.

Download the Mesa Admin API Postman Collection to quickly get started in Postman:

Automations 3

Description

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "inputs": [], "outputs": [], "secrets": [], "storage": [], "files": [], "overwrite": false }
Description

Updates the Inputs, Outputs, Secrets and Storage for an automation. Updating scripts requires separate calls to the Script POST endpoing for each script.

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "key": "", "name": "", "config": { "inputs": [], "outputs": [], "secrets": [], "storage": [], "files": [], "overwrite": false } }
Description

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "inputs": [], "outputs": [], "secrets": [], "storage": [], "files": [], "overwrite": false }
Logs 1

Description

Returns a list of the most recent 50 log entries.

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
Headers
KeyValueDescription
x-api-key{{api_key}}
Scripts 3

Description

Returns a list of all Scripts, including the Script code.

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
Headers
KeyValueDescription
x-api-key{{api_key}}
Description

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "script": { "filename": "myscript.js", "code": "// Javascript goes here" } }
Description

URL Parameters
KeyDescription
{{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 Secret, which can be found Mesa Automation page.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "filename": "" }
Secrets 4

Description

Returns a list of all Sectret names. Secret values are not available via the Admin API.

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
Headers
KeyValueDescription
x-api-key{{api_key}}
Description

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "secret": { "key": "mysecret", "value": "myvalue" } }
Description

URL Parameters
KeyDescription
{{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 Secret, which can be found on the Automation page in the Mesa Dashboard.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "secret": { "value": "myvalue" } }
Description

URL Parameters
KeyDescription
{{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 Secret, which can be obtained from the Secrets tab of the Mesa Dashboard.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Storage 5

Description

Returns a list of all Storage item names. To get a Storage value, call GET {{url}}/admin/{{uuid}}/storage/{{storage_name}}.json

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
Headers
KeyValueDescription
x-api-key{{api_key}}
Description

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
{{storage_key}}The of the storage item, which can be obtained from the Storage tab of the Mesa Dashboard.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Description

Value parameter can be a string, an object, an array, or a boolean value.

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "storage": { "key": "{{storage_key}}", "value": { "mykey": "myvalue" } } }
Description

Value parameter can be a string, an object, an array, or a boolean value.

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{storage_name}}The of the storage item, which can be obtained from the Storage tab of the Mesa Dashboard.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "storage": { "value": "mynewstringvalue" } }
Description

Delete a Storage item.

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
{{storage_name}}The of the storage item, which can be found on the Automation page in the Mesa Dashboard.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Task 1

Description

Returns a list of the most recent 50 log entries.

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{task_id}}The task_id to replay.
Headers
KeyValueDescription
x-api-key{{api_key}}
Templates 1

Description

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "template": "shoppad/mesa-templates/tests/kitchen-sink", "force": true }
Triggers 1

Description

URL Parameters
KeyDescription
{{uuid}}Your store’s unique identifier: {{uuid}}.myshopify.com.
{{automation_key}}The automation’s key. Example: shoppad/mesa-templates/shopify/draft-order/remove.
{{trigger_key}}The key of the Input or Output, which can be found Mesa Automation page.
Headers
KeyValueDescription
x-api-key{{api_key}}
Content-Typeapplication/json
Body
{ "secret": { "name": "mysecret", "value": "myvalue" } }
Available Variables 3
KeyValueType
{{url}}https://api.getmesa.com/v1string
{{api_key}}string
{{uuid}}string