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.

GEThttp://{{url}}/admin/{uuid}/automations.json

Path parameters

uuid*string

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/automations.json', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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": "<p>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.</p>",
          "video": "",
          "is_premium": false,
          "tags": [],
          "source": "",
          "destination": "",
          "enabled": false,
          "did_complete": false,
          "logging": true,
          "debug": false,
          "setup": "incomplete",
          "seconds": 135,
          "notifications": {
            "enabled": false,
            "emails": [
              "[e-mail]"
            ]
          },
          "_id": "65f1fdbbb54ac273e806026b",
          "created_at": "Mar 13 2020",
          "updated_at": "Mar 13 2024",
          "__$markdownParsed": true
        }
      ]
    }),
});
const data = await response.json();

Get the mesa.json file for an automation

GEThttp://{{url}}/admin/{uuid}/automations/{automation_key}.json

Path parameters

uuid*string

automation_key*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/automations/{automation_key}.json', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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.

POSThttp://{{url}}/admin/{uuid}/automations.json

Path parameters

uuid*string

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/automations.json', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "",
      "name": "",
      "config": {
        "inputs": [],
        "outputs": [],
        "secrets": [],
        "storage": [],
        "files": [],
        "overwrite": false
      }
    }),
});
const data = await response.json();

Uninstall an Automation

DELETEhttp://{{url}}/admin/{uuid}/automations/{automation_key}.json

Path parameters

uuid*string

automation_key*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/automations/{automation_key}.json', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Credentials

Get a list of Credentials

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

GEThttp://{{url}}/admin/{uuid}/{automation_key}/credentials.json

Path parameters

uuid*string

automation_key*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/credentials.json', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a new Credential

POSThttp://{{url}}/admin/{uuid}/{automation_key}/credentials.json

Path parameters

uuid*string

automation_key*string

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/credentials.json', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "secret": {
        "key": "mysecret",
        "value": "myvalue"
      }
    }),
});
const data = await response.json();

Update an existing Credential

PUThttp://{{url}}/admin/{uuid}/{automation_key}/credentials/{credential_key}.json

Path parameters

uuid*string

automation_key*string

secret_key*string

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/credentials/{credential_key}.json', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "secret": {
        "value": "myvalue"
      }
    }),
});
const data = await response.json();

Delete a Credential

DELETEhttp://{{url}}/admin/{uuid}/{automation_key}/credentials/{credential_key}.json

Path parameters

uuid*string

automation_key*string

secret_key*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/credentials/{credential_key}.json', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

GEThttp://{{url}}/admin/{uuid}/{automation_key}/storage.json

Path parameters

uuid*string

automation_key*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/storage.json', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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.

POSThttp://{{url}}/admin/{uuid}/{automation_key}/storage.json

Path parameters

uuid*string

automation_key*string

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/storage.json', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "storage": {
        "key": "{{storage_key}}",
        "value": {
          "mykey": "myvalue"
        }
      }
    }),
});
const data = await response.json();

Get the value of a Storage item

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

GEThttp://{{url}}/admin/{uuid}/{automation_key}/storage/{storage_key}.json

Path parameters

uuid*string

automation_key*string

storage_key*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/storage/{storage_key}.json', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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.

PUThttp://{{url}}/admin/{uuid}/{automation_key}/storage/{storage_key}.json

Path parameters

uuid*string

automation_key*string

storage_key*string

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/storage/{storage_key}.json', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "storage": {
        "value": "mynewstringvalue"
      }
    }),
});
const data = await response.json();

Deletes a Storage item

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

DELETEhttp://{{url}}/admin/{uuid}/{automation_key}/storage/{storage_key}.json

Path parameters

uuid*string

automation_key*string

storage_key*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/storage/{storage_key}.json', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Scripts

Get a list of Scripts

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

GEThttp://{{url}}/admin/{uuid}/{automation_key}/scripts.json

Path parameters

uuid*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/scripts.json', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create or update a Script

POSThttp://{{url}}/admin/{uuid}/{automation_key}/scripts.json

Path parameters

uuid*string

automation_key*string

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/scripts.json', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "script": {
        "filename": "myscript.js",
        "code": "// Javascript goes here"
      }
    }),
});
const data = await response.json();

Delete a Script

DELETEhttp://{{url}}/admin/{uuid}/{automation_key}/scripts.json

Path parameters

uuid*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/scripts.json', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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.

POSThttp://{{url}}/admin/{uuid}/{automation_key}/triggers/{trigger_key}/test.json

Path parameters

uuid*string

automation_key*string

trigger_key*string

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/{automation_key}/triggers/{trigger_key}/test.json', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "payload": {}
    }),
});
const data = await response.json();

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.

POSThttp://{{url}}/admin/{uuid}/tasks/{task_id}/replay.json

Path parameters

uuid*string

task_id*string

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

Header parameters

Body

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/tasks/{task_id}/replay.json', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Templates

Install a template from the Mesa Template library

POSThttp://{{url}}/admin/{uuid}/templates/install.json

Path parameters

uuid*string

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/templates/install.json', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "template": "shoppad/mesa-templates/tests/kitchen-sink",
      "force": true
    }),
});
const data = await response.json();

Logs

Get the 50 most recent log entries

Returns a list of the most recent 50 log entries.

GEThttp://{{url}}/admin/{uuid}/logs.json

Path parameters

uuid*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('http://{{url}}/admin/{uuid}/logs.json', {
    method: 'GET',
    headers: {},
});
const data = await response.json();