Admin API

The MESA Admin API allows you to programmatically interact with MESA. All requests must include your API key which can be found in My Account > Credentials.

Key	Value
{url}	https://api.getmesa.com/v1
{uuid}	Your store’s unique identifier: {{uuid}}.myshopify.com

Workflows

Get list of automations

Returns a list of automations for a store, sorted by most recently created first.

get

/admin/{uuid}/automations.json

Path parameters

uuidstringrequired

Header parameters

x-api-keystring

Example: {{api_key}}

Body

object

Example: {"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,"source":"","destination":"","enabled":false,"did_complete":false,"logging":true,"debug":false,"setup":"incomplete","seconds":135,"_id":"65f1fdbbb54ac273e806026b","created_at":"Mar 13 2020","updated_at":"Mar 13 2024","tags":[],"notifications":{"enabled":false,"emails":["[e-mail]"]}}]}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{url}}/admin/{uuid}/automations.json' \
  --header 'Content-Type: application/json' \
  --data '{"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,"source":"","destination":"","enabled":false,"did_complete":false,"logging":true,"debug":false,"setup":"incomplete","seconds":135,"_id":"65f1fdbbb54ac273e806026b","created_at":"Mar 13 2020","updated_at":"Mar 13 2024","tags":[],"notifications":{"enabled":false,"emails":["[e-mail]"]}}]}'

200

200

No body

Successful response

Get the mesa.json file for an automation

get

/admin/{uuid}/automations/{automation_key}.json

Path parameters

uuidstringrequired

automation_keystringrequired

Header parameters

x-api-keystring

Example: {{api_key}}

Content-Typestring

Example: application/json

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{url}}/admin/{uuid}/automations/{automation_key}.json'

200

200

No body

Successful response

Create or update an Automation configuration

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

post

/admin/{uuid}/automations.json

Path parameters

uuidstringrequired

Header parameters

x-api-keystring

Example: {{api_key}}

Body

object

Example: {"key":"","name":"","config":{"overwrite":false,"inputs":[],"outputs":[],"secrets":[],"storage":[],"files":[]}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{url}}/admin/{uuid}/automations.json' \
  --header 'Content-Type: application/json' \
  --data '{"key":"","name":"","config":{"overwrite":false,"inputs":[],"outputs":[],"secrets":[],"storage":[],"files":[]}}'

200

200

No body

Successful response

Uninstall an Automation

delete

/admin/{uuid}/automations/{automation_key}.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

Header parameters

x-api-keystring

Example: {{api_key}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://{{url}}/admin/{uuid}/automations/{automation_key}.json'

200

200

No body

Successful response

Credentials

Get a list of Credentials

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

get

/admin/{uuid}//{automation_key}/credentials.json

Path parameters

uuidstringrequired

automation_keystringrequired

Header parameters

x-api-keystring

Example: {{api_key}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/credentials.json'

200

200

No body

Successful response

Create a new Credential

post

/admin/{uuid}//{automation_key}/credentials.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

Header parameters

x-api-keystring

Example: {{api_key}}

Body

object

Example: {"secret":{"key":"mysecret","value":"myvalue"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/credentials.json' \
  --header 'Content-Type: application/json' \
  --data '{"secret":{"key":"mysecret","value":"myvalue"}}'

200

200

No body

Successful response

Update an existing Credential

put

/admin/{uuid}//{automation_key}/credentials/{credential_key}.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

secret_keystringrequired

Header parameters

x-api-keystring

Example: {{api_key}}

Body

object

Example: {"secret":{"value":"myvalue"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/credentials/{credential_key}.json' \
  --header 'Content-Type: application/json' \
  --data '{"secret":{"value":"myvalue"}}'

200

200

No body

Successful response

Delete a Credential

<h5 class="label label-primary">URL Parameters</h5> <table class="table"> <thead> <tr> <th>Key</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>{{uuid}}</td> <td>Your store's unique identifier: {{uuid}}.myshopify.com.</td> </tr> <tr> <td>{{automation_key}}</td> <td>The automation's key. Example: shoppad/mesa-templates/shopify/draft-order/remove.</td> </tr> <tr> <td>{{secret_key}}</td> <td>The key of the Credential, which can be obtained from the Credentials tab of the Mesa Dashboard.</td> </tr> </tbody> </table>

delete

/admin/{uuid}//{automation_key}/credentials/{credential_key}.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

secret_keystringrequired

Example: googlesheets_1

Header parameters

x-api-keystring

Example: {{api_key}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/credentials/{credential_key}.json'

200

200

No body

Successful response

Storage

Get a list of all Storage items

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

get

/admin/{uuid}//{automation_key}/storage.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

Header parameters

x-api-keystring

Example: {{api_key}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/storage.json'

200

200

No body

Successful response

Create a new Storage item

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.

post

/admin/{uuid}//{automation_key}/storage.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

Header parameters

x-api-keystring

Example: {{api_key}}

Body

object

Example: {"storage":{"key":"{{storage_key}}","value":{"mykey":"myvalue"}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/storage.json' \
  --header 'Content-Type: application/json' \
  --data '{"storage":{"key":"{{storage_key}}","value":{"mykey":"myvalue"}}}'

200

200

No body

Successful response

Get the value of a Storage item

Note: Storage has been deprecated in favor of Data by MESA.

get

/admin/{uuid}//{automation_key}/storage/{storage_key}.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

storage_keystringrequired

Example: storage_1

Header parameters

x-api-keystring

Example: {{api_key}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/storage/{storage_key}.json'

200

200

No body

Successful response

Update an existing Storage item

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.

put

/admin/{uuid}//{automation_key}/storage/{storage_key}.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

storage_keystringrequired

Example: storage_1

Header parameters

x-api-keystring

Example: {{api_key}}

Body

object

Example: {"storage":{"value":"mynewstringvalue"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/storage/{storage_key}.json' \
  --header 'Content-Type: application/json' \
  --data '{"storage":{"value":"mynewstringvalue"}}'

200

200

No body

Successful response

Deletes a Storage item

Note: Storage has been deprecated in favor of Data by MESA. Delete a Storage item.

delete

/admin/{uuid}//{automation_key}/storage/{storage_key}.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

storage_keystringrequired

Example: storage_1

Header parameters

x-api-keystring

Example: {{api_key}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/storage/{storage_key}.json'

200

200

No body

Successful response

Scripts

Get a list of Scripts

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

get

/admin/{uuid}//{automation_key}/scripts.json

Path parameters

uuidstringrequired

Header parameters

x-api-keystring

Example: {{api_key}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/scripts.json'

200

200

No body

Successful response

Create or update a Script

post

/admin/{uuid}//{automation_key}/scripts.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

Header parameters

x-api-keystring

Example: {{api_key}}

Body

object

Example: {"script":{"filename":"myscript.js","code":"// Javascript goes here"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/scripts.json' \
  --header 'Content-Type: application/json' \
  --data '{"script":{"filename":"myscript.js","code":"// Javascript goes here"}}'

200

200

No body

Successful response

Delete a Script

delete

/admin/{uuid}//{automation_key}/scripts.json

Path parameters

uuidstringrequired

Header parameters

x-api-keystring

Example: {{api_key}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/scripts.json'

200

200

No body

Successful response

Testing

Run a test

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.

post

/admin/{uuid}//{automation_key}/triggers/{trigger_key}/test.json

Path parameters

uuidstringrequired

automation_keystringrequired

Example: new_workflow_1

trigger_keystringrequired

Example: shopify_1

Header parameters

x-api-keystring

Example: {{api_key}}

Body

object

Example: {"payload":{}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{url}}/admin/{uuid}/{automation_key}/triggers/{trigger_key}/test.json' \
  --header 'Content-Type: application/json' \
  --data '{"payload":{}}'

200

200

No body

Successful response

Tasks

Replay a task

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.

post

/admin/{uuid}/tasks/{task_id}/replay.json

Path parameters

uuidstringrequired

task_idstringrequired

To find the Task ID, click on a step in the Activity List > Request Details, and copy the last ID hash from the URL

Example: 65f3459357ca4e809608c8fb

Header parameters

x-api-keystring

Example: {{api_key}}

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{url}}/admin/{uuid}/tasks/{task_id}/replay.json'

200

200

No body

Successful response

Templates

Install a template from the Mesa Template library

post

/admin/{uuid}/templates/install.json

Path parameters

uuidstringrequired

Header parameters

x-api-keystring

Example: {{api_key}}

Body

object

Example: {"template":"shoppad/mesa-templates/tests/kitchen-sink","force":true}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{url}}/admin/{uuid}/templates/install.json' \
  --header 'Content-Type: application/json' \
  --data '{"template":"shoppad/mesa-templates/tests/kitchen-sink","force":true}'

200

200

No body

Successful response

Logs

Get the 50 most recent log entries

Returns a list of the most recent 50 log entries.

get

/admin/{uuid}/logs.json

Path parameters

uuidstringrequired

Header parameters

x-api-keystring

Example: {{api_key}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{url}}/admin/{uuid}/logs.json'

200

200

No body

Successful response