Retrieve a single integration

GET 
https://embedded.runalloy.com/2024-03//integrations/:integrationId

Finds a specific integration for a user

Request

Path Parameters

integrationId stringrequired

This API parameter allows you to filter results based on the integrationId or the integrationName (also referred to as 'app'). The integration name (app) is a custom name that you have set for your integration. When using the integration name (app), provide the name of the integration you want to filter for (e.g. 'shopify order sync' or 'magento product creation'). You can obtain the integration name (app) from the List Integrations endpoint under the 'app' parameter, or by checking your UI. Either integrationId or integrationName must be provided but it cannot be both.

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

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"
            }
          ]
        }
    ]
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://embedded.runalloy.com/2024-03/integrations/:integrationId' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://embedded.runalloy.com/2024-03

Parameters

integrationId — pathrequired

userId — queryrequired

Authorization — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!