Integration

List Integrations

get

Returns a list of Integrations, which is list of templates merged with list of states and list of scenarios.

Responses
200
List of Integrations returned successfully.
application/json
get
GET /portal/api/bridge/integrations/ HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

List of Integrations returned successfully.

{
  "integrations": [
    {
      "scenario": {
        "id": 1,
        "name": "text",
        "isActive": true,
        "usedPackages": [
          "text"
        ],
        "scheduling": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "state": {
        "isConnected": true
      },
      "template": {
        "versionUid": 1,
        "instanceableId": 1
      }
    }
  ]
}

Initialize Integration using Template ID

post

Initializes a new integration using a bridge template.

Path parameters
instanceableIdintegerRequired
Query parameters
teamIdintegerOptional
Body
any ofOptional
Responses
200
Integration has started initialization.
application/json
post
POST /portal/api/bridge/integrations/init/{instanceableId} HTTP/1.1
Host: <zone>.make.com
Content-Type: application/json
Accept: */*
Content-Length: 333

{
  "teamId": 1,
  "templateId": 1,
  "algorithm": "whiteboard",
  "prefill": {
    "hard": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "soft": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "allowReusingComponents": true,
  "allowCreatingComponents": true,
  "autoActivate": true,
  "autoFinalize": true,
  "redirectUri": "text",
  "scenario": {
    "name": "text",
    "enable": false,
    "folderId": 1
  }
}
200

Integration has started initialization.

{
  "publicUrl": "text",
  "flow": {
    "id": "text"
  }
}

Check Integration Initiation

get

Checks the status of integration initiation.

Path parameters
flowIdstringRequired
Query parameters
teamIdintegerOptional
Responses
200
Integration initialization check.
application/json
get
GET /portal/api/bridge/integrations/check-init/{flowId} HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Integration initialization check.

{
  "flow": {
    "id": "text",
    "statusId": 1,
    "statusMessage": "text",
    "isCompleted": true,
    "result": {
      "scenarios": [
        {
          "id": 1,
          "description": "text"
        }
      ]
    }
  }
}

Activate Integration using Scenario ID

post

Activates a specific integration which is done by activating a Scenario.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Responses
200
Integration activated successfully.
application/json
post
POST /portal/api/bridge/integrations/{scenarioId}/activate HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Integration activated successfully.

{
  "integration": {
    "scenarioId": 1
  }
}

Deactivate Integration using Scenario ID

post

Deactivates a specific integration which is done by deactivating a Scenario.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Responses
200
Integration deactivated successfully.
application/json
post
POST /portal/api/bridge/integrations/{scenarioId}/deactivate HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Integration deactivated successfully.

{
  "integration": {
    "scenarioId": 1
  }
}

Delete Integration

delete

Deletes a specific integration by calling Web API to delete a Scenario.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Responses
200
Integration deleted successfully.
application/json
delete
DELETE /portal/api/bridge/integrations/{scenarioId} HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Integration deleted successfully.

{
  "message": "text"
}

Run an Integration using Scenario ID

post

Runs a specific Integration.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Body
any ofOptional
Responses
200
Integration run successfully.
application/json
post
POST /portal/api/bridge/integrations/{scenarioId}/run HTTP/1.1
Host: <zone>.make.com
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "responsive": true
}
200

Integration run successfully.

{
  "executionId": "text",
  "statusUrl": "text",
  "status": null,
  "outputs": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}