Retrieve a list of all integrations

GET 
/integrations

Returns all the available integrations in your Alloy Embedded Account. Includes integrations/apps you've created an "integration" for, their workflows and statuses. If installed equals true, the installedVersion key will show the currently installed version.

Request

Query Parameters

userId stringrequired

The Id used to identify the user. Note: you can also use the Embedded user's username in this field.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

data

object[]

Array [

integrationId string

app string

installed boolean

Default value: true

icon string

workflows

object[]

Array [

workflowId string

name string

installed boolean

Default value: true

version integer

Default value: 0

installedVersion integer

Default value: 0

active boolean

Default value: true

blocks

object[]

Array [

name string

id string

type string

icon string

]

]

]

Example (from schema)

{
  "data": [
    {
      "integrationId": "63ea758e82c3074141968bb9",
      "app": "Magento",
      "installed": false,
      "icon": "https://cdn.runalloy.com/icons/magento.png",
      "workflows": [
        {
          "workflowId": "63ea75a2fcf2e2c72e805ddc",
          "name": "Magento Order Sync",
          "installed": true,
          "version": 1,
          "installedVersion": 1,
          "active": true,
          "blocks": [
            {
              "name": "Custom Event",
              "id": "bc9202b2-8e7e-47d4-9416-5ba6b319fa2a",
              "type": "customEvent",
              "icon": "https://cdn.runalloy.com/icons/app-event.svg"
            }
          ]
        }
      ]
    }
  ]
}

Result

{
  "data": [
    {
      "integrationId": "63ea758e82c3074141968bb9",
      "app": "Magento",
      "installed": false,
      "icon": "https://cdn.runalloy.com/icons/magento.png",
      "workflows": [
        {
          "workflowId": "63ea75a2fcf2e2c72e805ddc",
          "name": "Magento Order Sync",
          "installed": true,
          "version": 1,
          "installedVersion": 1,
          "active": true,
          "blocks": [
            {
              "name": "Custom Event",
              "id": "bc9202b2-8e7e-47d4-9416-5ba6b319fa2a",
              "type": "customEvent",
              "icon": "https://cdn.runalloy.com/icons/app-event.svg"
            },
            {
              "name": "Magento",
              "id": "3363c9da-1f96-403a-bdfd-856fa5e76dad",
              "type": "magento",
              "icon": "https://cdn.runalloy.com/icons/magento.png"
            }
          ]
        }
      ]
    },
    {
      "integrationId": "63ea7595ddf9f00a17f9d2cc",
      "app": "Xero",
      "installed": false,
      "icon": "https://cdn.runalloy.com/icons/xero.png",
      "workflows": [
        {
          "workflowId": "63ea759e28fa3c9ff514c2ca",
          "name": "Sync Xero Transactions every hour",
          "installed": false,
          "active": false,
          "version": 1,
          "blocks": [
            {
              "name": "Schedule Workflow",
              "id": "2c5d9d2a-d38e-44d2-8d0b-8f006c588937",
              "type": "cron",
              "icon": "https://cdn.runalloy.com/icons/cron.png"
            },
            {
              "name": "Xero",
              "id": "0f2bf1ef-109b-4a0d-ace3-24bf329efcdf",
              "type": "xero",
              "icon": "https://cdn.runalloy.com/icons/xero.png"
            }
          ]
        }
      ]
    }
  ]
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...