Integrations

GET `/integrations`

List the organization's connected storefront integrations, newest first. Access tokens are never returned.

Requires the settings:read permission.

Query parameters

limitnumber

The number of records to return.

cursorstring

A pagination cursor. Fetch the next page by passing the nextCursor value from the previous response.

sortcreatedAt | -createdAt

The sort order. Prefix a field with - to sort descending. Defaults to -createdAt.

filterstring

A JSON-encoded filter document, for example {"createdAt":{"$gte":"2025-01-01T00:00:00Z"}}. Filterable fields: id, type, createdAt. See Filtering for the syntax.

Request

curl \
  "https://your-store.meisei.app/api/integrations" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY"

Request

import { client } from "@meisei/api/admin/client"
import { getIntegrations } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await getIntegrations()

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

page = meisei.integrations.list

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

page = meisei.integrations.list()

Response

{
  "data": [
    {
      "id": "A4Ws1igz",
      "type": "shopify",
      "publicData": "...",
      "createdAt": "2025-01-15T09:30:00Z",
      "updatedAt": "2025-01-15T09:30:00Z"
    }
  ],
  "nextCursor": "string"
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the integration.",
            "idCodec": "sqid"
          },
          "type": {
            "type": "string",
            "enum": ["shopify", "slack", "klaviyo"],
            "description": "Which platform the integration connects to."
          },
          "publicData": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {},
            "description": "Connection details safe to show, such as the store domain and sync settings. Credentials are never included."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
            "description": "When the integration was connected."
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
            "description": "When the integration was last changed."
          }
        },
        "required": ["id", "type", "publicData", "createdAt", "updatedAt"],
        "additionalProperties": false
      },
      "description": "The page of records, in the requested sort order."
    },
    "nextCursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Pass this back as `cursor` to fetch the next page. Null once the last page has been returned."
    }
  },
  "required": ["data", "nextCursor"],
  "additionalProperties": false
}

GET `/integrations/{id}`

Get a single integration by ID.

Requires the settings:read permission.

Path parameters

idstringrequired

The ID of the integration.

Request

curl \
  "https://your-store.meisei.app/api/integrations/A4Ws1igz" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY"

Request

import { client } from "@meisei/api/admin/client"
import { getIntegrationsById } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await getIntegrationsById({
  path: { id: "A4Ws1igz" },
})

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

result = meisei.integrations.retrieve("A4Ws1igz")

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

result = meisei.integrations.retrieve("A4Ws1igz")

Response

{
  "id": "A4Ws1igz",
  "type": "shopify",
  "publicData": "...",
  "createdAt": "2025-01-15T09:30:00Z",
  "updatedAt": "2025-01-15T09:30:00Z"
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the integration.",
      "idCodec": "sqid"
    },
    "type": {
      "type": "string",
      "enum": ["shopify", "slack", "klaviyo"],
      "description": "Which platform the integration connects to."
    },
    "publicData": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "Connection details safe to show, such as the store domain and sync settings. Credentials are never included."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was connected."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was last changed."
    }
  },
  "required": ["id", "type", "publicData", "createdAt", "updatedAt"],
  "additionalProperties": false,
  "description": "The requested integration."
}

PATCH `/integrations/{id}`

Update how a connected integration behaves in Meisei. Only the settings you send are changed, and the rest are left alone. These are Meisei's own settings, not the store's.

Requires the settings:write permission.

Path parameters

idstringrequired

The ID of the integration.

Body parameters

settingsobject | object | object

The settings to change, in the shape the integration's type takes. Anything you leave out keeps its current value.

channelstring | null

Slack only. The channel this connection posts to, as a label to show in Meisei.

webhookUrlstring

Slack only. A replacement incoming webhook URL, for pointing an existing connection at a different channel.

apiKeystring

Klaviyo only. A replacement private API key, for rotating the one this connection holds.

Request

curl \
  -X PATCH \
  "https://your-store.meisei.app/api/integrations/A4Ws1igz" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "settings": {
    "onProductDelete": "delete",
    "onCustomerDelete": "delete",
    "onOrderDelete": "delete",
    "earnOn": "orderCreated",
    "earnOnBackfill": true,
    "followHandleRenames": true,
    "metafieldMappings": [
      {
        "resource": "...",
        "namespace": "...",
        "key": "...",
        "metadataKey": "..."
      }
    ]
  },
  "channel": "string",
  "webhookUrl": "string",
  "apiKey": "string"
}'

Request

import { client } from "@meisei/api/admin/client"
import { patchIntegrationsById } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await patchIntegrationsById({
  path: { id: "A4Ws1igz" },
  body: {
    settings: {
      onProductDelete: "delete",
      onCustomerDelete: "delete",
      onOrderDelete: "delete",
      earnOn: "orderCreated",
      earnOnBackfill: true,
      followHandleRenames: true,
      metafieldMappings: [
        {
          resource: "...",
          namespace: "...",
          key: "...",
          metadataKey: "...",
        },
      ],
    },
    channel: "string",
    webhookUrl: "string",
    apiKey: "string",
  },
})

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

result = meisei.integrations.update(
  "A4Ws1igz",
  settings: {
    on_product_delete: "delete",
    on_customer_delete: "delete",
    on_order_delete: "delete",
    earn_on: "orderCreated",
    earn_on_backfill: true,
    follow_handle_renames: true,
    metafield_mappings: [{ resource: "...", namespace: "...", key: "...", metadata_key: "..." }],
  },
  channel: "string",
  webhook_url: "string",
  api_key: "string",
)

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

result = meisei.integrations.update(
    "A4Ws1igz",
    settings={
        "on_product_delete": "delete",
        "on_customer_delete": "delete",
        "on_order_delete": "delete",
        "earn_on": "orderCreated",
        "earn_on_backfill": True,
        "follow_handle_renames": True,
        "metafield_mappings": [
            {
                "resource": "product",
                "namespace": "...",
                "key": "...",
                "metadata_key": "...",
            },
        ],
    },
    channel="string",
    webhook_url="string",
    api_key="string",
)

Response

{
  "id": "A4Ws1igz",
  "type": "shopify",
  "publicData": "...",
  "createdAt": "2025-01-15T09:30:00Z",
  "updatedAt": "2025-01-15T09:30:00Z"
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the integration.",
      "idCodec": "sqid"
    },
    "type": {
      "type": "string",
      "enum": ["shopify", "slack", "klaviyo"],
      "description": "Which platform the integration connects to."
    },
    "publicData": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "Connection details safe to show, such as the store domain and sync settings. Credentials are never included."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was connected."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was last changed."
    }
  },
  "required": ["id", "type", "publicData", "createdAt", "updatedAt"],
  "additionalProperties": false,
  "description": "The updated integration."
}

DELETE `/integrations/{id}`

Disconnect an integration. Syncing stops and the stored access token is discarded. Records already synced into Meisei are kept.

Requires the settings:write permission.

Path parameters

idstringrequired

The ID of the integration to disconnect.

Request

curl \
  -X DELETE \
  "https://your-store.meisei.app/api/integrations/A4Ws1igz" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY"

Request

import { client } from "@meisei/api/admin/client"
import { deleteIntegrationsById } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await deleteIntegrationsById({
  path: { id: "A4Ws1igz" },
})

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

result = meisei.integrations.delete("A4Ws1igz")

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

result = meisei.integrations.delete("A4Ws1igz")

Response

{
  "id": "A4Ws1igz",
  "type": "shopify",
  "publicData": "...",
  "createdAt": "2025-01-15T09:30:00Z",
  "updatedAt": "2025-01-15T09:30:00Z"
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the integration.",
      "idCodec": "sqid"
    },
    "type": {
      "type": "string",
      "enum": ["shopify", "slack", "klaviyo"],
      "description": "Which platform the integration connects to."
    },
    "publicData": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "Connection details safe to show, such as the store domain and sync settings. Credentials are never included."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was connected."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was last changed."
    }
  },
  "required": ["id", "type", "publicData", "createdAt", "updatedAt"],
  "additionalProperties": false,
  "description": "The disconnected integration."
}

POST `/integrations/slack`

Connect Slack by storing an incoming webhook URL. Meisei posts the message types you switch on, plus an optional daily or weekly summary, to the channel that webhook belongs to. One Slack connection per organization.

Requires the settings:write permission.

Body parameters

webhookUrlstringrequired

The Slack incoming webhook URL to post to. Create one in Slack under your app's Incoming Webhooks, picking the channel it posts to. It is a credential, so Meisei never shows it again once saved.

channelstring | null

The channel the webhook posts to, such as #reviews. Slack does not report this back, so it is a label for your own reference.

Request

curl \
  -X POST \
  "https://your-store.meisei.app/api/integrations/slack" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "webhookUrl": "string",
  "channel": "string"
}'

Request

import { client } from "@meisei/api/admin/client"
import { postIntegrationsSlack } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await postIntegrationsSlack({
  body: {
    webhookUrl: "string",
    channel: "string",
  },
})

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

result = meisei.integrations.create_slack(
  webhook_url: "string",
  channel: "string",
)

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

result = meisei.integrations.create_slack(
    webhook_url="string",
    channel="string",
)

Response

{
  "id": "A4Ws1igz",
  "type": "shopify",
  "publicData": "...",
  "createdAt": "2025-01-15T09:30:00Z",
  "updatedAt": "2025-01-15T09:30:00Z"
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the integration.",
      "idCodec": "sqid"
    },
    "type": {
      "type": "string",
      "enum": ["shopify", "slack", "klaviyo"],
      "description": "Which platform the integration connects to."
    },
    "publicData": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "Connection details safe to show, such as the store domain and sync settings. Credentials are never included."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was connected."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was last changed."
    }
  },
  "required": ["id", "type", "publicData", "createdAt", "updatedAt"],
  "additionalProperties": false,
  "description": "The new Slack connection."
}

POST `/integrations/klaviyo`

Connect Klaviyo with a private API key. Meisei sends the events you switch on as Klaviyo metrics, keeps each customer's Meisei properties up to date on their profile, and imports current state for the customers it already knows about. One Klaviyo connection per organization.

Requires the settings:write permission.

Body parameters

apiKeystringrequired

The Klaviyo private API key to send events and profile updates with. Create one in Klaviyo under Settings, API keys, with write access to profiles, events and lists. It is a credential, so Meisei never shows it again once saved.

Request

curl \
  -X POST \
  "https://your-store.meisei.app/api/integrations/klaviyo" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "apiKey": "string"
}'

Request

import { client } from "@meisei/api/admin/client"
import { postIntegrationsKlaviyo } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await postIntegrationsKlaviyo({
  body: {
    apiKey: "string",
  },
})

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

result = meisei.integrations.create_klaviyo(api_key: "string")

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

result = meisei.integrations.create_klaviyo(api_key="string")

Response

{
  "id": "A4Ws1igz",
  "type": "shopify",
  "publicData": "...",
  "createdAt": "2025-01-15T09:30:00Z",
  "updatedAt": "2025-01-15T09:30:00Z"
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the integration.",
      "idCodec": "sqid"
    },
    "type": {
      "type": "string",
      "enum": ["shopify", "slack", "klaviyo"],
      "description": "Which platform the integration connects to."
    },
    "publicData": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "Connection details safe to show, such as the store domain and sync settings. Credentials are never included."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was connected."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "When the integration was last changed."
    }
  },
  "required": ["id", "type", "publicData", "createdAt", "updatedAt"],
  "additionalProperties": false,
  "description": "The new Klaviyo connection."
}

GET `/integrations/{id}/klaviyo-lists`

List the Klaviyo audiences this connection can add customers to. Meisei calls Klaviyo live, so a list created a moment ago is here.

Requires the settings:read permission.

Path parameters

idstringrequired

The ID of the Klaviyo integration.

Request

curl \
  "https://your-store.meisei.app/api/integrations/A4Ws1igz/klaviyo-lists" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY"

Request

import { client } from "@meisei/api/admin/client"
import { getIntegrationsByIdKlaviyoLists } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await getIntegrationsByIdKlaviyoLists({
  path: { id: "A4Ws1igz" },
})

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

result = meisei.integrations.klaviyo_lists("A4Ws1igz")

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

result = meisei.integrations.klaviyo_lists("A4Ws1igz")

Response

{
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Klaviyo's ID for the list."
          },
          "name": {
            "type": "string",
            "description": "The list's name in Klaviyo."
          }
        },
        "required": ["id", "name"],
        "additionalProperties": false
      },
      "description": "The lists on the connected account."
    }
  },
  "required": ["data"],
  "additionalProperties": false,
  "description": "The connected account's lists."
}

POST `/integrations/{id}/test`

Check that a connection still works. For Slack this posts a test message to the channel; for Klaviyo it asks Klaviyo who the credentials belong to. Unlike a real notification, this reports the failure rather than swallowing it, so a credential that has been revoked shows up here rather than as silence.

Requires the settings:write permission.

Path parameters

idstringrequired

The ID of the integration to test.

Request

curl \
  -X POST \
  "https://your-store.meisei.app/api/integrations/A4Ws1igz/test" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY"

Request

import { client } from "@meisei/api/admin/client"
import { postIntegrationsByIdTest } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await postIntegrationsByIdTest({
  path: { id: "A4Ws1igz" },
})

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

result = meisei.integrations.test("A4Ws1igz")

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

result = meisei.integrations.test("A4Ws1igz")

Response

{
  "ok": true,
  "error": "string"
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the integration accepted the call."
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "What went wrong, ready to show. Null when the message arrived."
    }
  },
  "required": ["ok", "error"],
  "additionalProperties": false,
  "description": "How the test went."
}

GET `/integrations/shopify/connect-context`

Check whether a Shopify store can be connected to this organization, and say why not if it cannot. The connect screen calls this so it never offers a button that would fail once the merchant is back in Shopify.

Requires the settings:read permission.

Query parameters

shopstringrequired

The myshopify.com domain of the store being connected

Request

curl \
  "https://your-store.meisei.app/api/integrations/shopify/connect-context" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY"

Request

import { client } from "@meisei/api/admin/client"
import { getIntegrationsShopifyConnectContext } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await getIntegrationsShopifyConnectContext({
  query: { shop: "string" },
})

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

result = meisei.integrations.shopify.connect_context(shop: "string")

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

result = meisei.integrations.shopify.connect_context(shop="string")

Response

{
  "shop": "string",
  "organization": {
    "id": "string",
    "name": "string"
  },
  "siteCount": 0,
  "siteLimit": 0,
  "blockedReason": "string"
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "shop": {
      "type": "string",
      "description": "The myshopify.com domain that was checked."
    },
    "organization": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for the organization."
        },
        "name": {
          "type": "string",
          "description": "The organization's display name."
        }
      },
      "required": ["id", "name"],
      "additionalProperties": false,
      "description": "The organization the store would be connected to."
    },
    "siteCount": {
      "type": "number",
      "description": "How many sites the organization already has."
    },
    "siteLimit": {
      "type": "number",
      "description": "How many sites its plan allows."
    },
    "blockedReason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Why the store cannot be connected, ready to show to the merchant. Null when the connection can go ahead."
    }
  },
  "required": ["shop", "organization", "siteCount", "siteLimit", "blockedReason"],
  "additionalProperties": false,
  "description": "What connecting this store would mean."
}

POST `/integrations/shopify/grant`

Authorize the Shopify connector to connect a store to the signed-in user's organization

Requires the settings:write permission.

Body parameters

shopstringrequired

The myshopify.com domain of the store being connected

statestringrequired

The ticket the Shopify app issued when the merchant started connecting, naming the store and the staff member.

Request

curl \
  -X POST \
  "https://your-store.meisei.app/api/integrations/shopify/grant" \
  -H "Authorization: Bearer sk_YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "shop": "string",
  "state": "string"
}'

Request

import { client } from "@meisei/api/admin/client"
import { postIntegrationsShopifyGrant } from "@meisei/api/admin"

client.setConfig({
  baseUrl: "https://your-store.meisei.app/api",
  headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})

const { data, error } = await postIntegrationsShopifyGrant({
  body: {
    shop: "string",
    state: "string",
  },
})

Request

require "meisei"

meisei = Meisei::Client.new(
  secret_key: "sk_YOUR_SECRET_KEY",
  base_url: "https://your-store.meisei.app/api",
)

result = meisei.integrations.shopify.grant(shop: "string", state: "string")

Request

from meisei import Client

meisei = Client(
    secret_key="sk_YOUR_SECRET_KEY",
    base_url="https://your-store.meisei.app/api",
)

result = meisei.integrations.shopify.grant(shop="string", state="string")

Response

{
  "grant": "string",
  "returnUrl": "string"
}

Response schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "grant": {
      "type": "string",
      "description": "A short-lived signed grant. Hand it back to the connector, which returns to the Shopify admin with it and connects the store from there."
    },
    "returnUrl": {
      "type": "string",
      "description": "The connector's address to send the grant to, as a `grant` query parameter. It is always Meisei's own Shopify host."
    }
  },
  "required": ["grant", "returnUrl"],
  "additionalProperties": false,
  "description": "The signed authorization to connect the store."
}

#Integrations

GET /integrations

Query parameters

GET /integrations/{id}

Path parameters

PATCH /integrations/{id}

Path parameters

Body parameters

DELETE /integrations/{id}

Path parameters

POST /integrations/slack

Body parameters

POST /integrations/klaviyo

Body parameters

GET /integrations/{id}/klaviyo-lists

Path parameters

POST /integrations/{id}/test

Path parameters

GET /integrations/shopify/connect-context

Query parameters

POST /integrations/shopify/grant

Body parameters

Integrations

GET `/integrations`

GET `/integrations/{id}`

PATCH `/integrations/{id}`

DELETE `/integrations/{id}`

POST `/integrations/slack`

POST `/integrations/klaviyo`

GET `/integrations/{id}/klaviyo-lists`

POST `/integrations/{id}/test`

GET `/integrations/shopify/connect-context`

POST `/integrations/shopify/grant`