Scenario

List Scenarios

get

Returns a list of Scenarios that were initialized from any of the integrations.

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

List of Scenarios returned successfully.

{
  "scenarios": [
    {
      "id": 1,
      "name": "text",
      "isActive": true,
      "islocked": true,
      "isPaused": true,
      "usedPackages": [
        "text"
      ],
      "scheduling": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "iswaiting": true,
      "nextExec": "text"
    }
  ]
}

Get Scenario by id

get

Returns a Scenario by ID.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Responses
200
Scenario returned successfully.
application/json
get
GET /portal/api/bridge/scenarios/{scenarioId} HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Scenario returned successfully.

{
  "id": 1,
  "name": "text",
  "isActive": true,
  "islocked": true,
  "isPaused": true,
  "usedPackages": [
    "text"
  ],
  "scheduling": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "iswaiting": true,
  "nextExec": "text"
}

Activate a Scenario using Scenario ID

post

Activates a specific Scenario.

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

Scenario activated successfully.

{
  "scenarioId": 1
}

Deactivate a Scenario using Scenario ID

post

Deactivates a specific Scenario.

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

Scenario deactivated successfully.

{
  "scenarioId": 1
}

Run a Scenario using Scenario ID

post

Runs a specific Scenario.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Body
any ofOptional
Responses
200
Scenario run successfully.
application/json
post
POST /portal/api/bridge/scenarios/{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

Scenario run successfully.

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

Get Scenario usage grouped by date

get

Returns the usage of a specific Scenario.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Responses
200
Scenario usage returned successfully.
application/json
get
GET /portal/api/bridge/scenarios/{scenarioId}/usage HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Scenario usage returned successfully.

[
  {
    "date": "text",
    "operations": 1,
    "dataTransfer": 1
  }
]

Get Scenario logs

get

Returns a list of the logs for a specific Scenario.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Responses
200
Scenario logs returned successfully.
application/json
get
GET /portal/api/bridge/scenarios/{scenarioId}/logs HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Scenario logs returned successfully.

[
  {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]

Get a Scenario execution log by scenario ID and execution ID

get

Returns an execution log by scenario ID and execution ID.

Path parameters
scenarioIdintegerRequired
executionIdstringRequired
Query parameters
teamIdintegerOptional
Responses
200
Scenario execution log returned successfully.
application/json
get
GET /portal/api/bridge/scenarios/{scenarioId}/logs/{executionId} HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Scenario execution log returned successfully.

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Scenario blueprint

get

Returns the latest version of a blueprint of a specific Scenario.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Responses
200
Scenario blueprint returned successfully.
application/json
get
GET /portal/api/bridge/scenarios/{scenarioId}/blueprint HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Scenario blueprint returned successfully.

{
  "blueprint": null
}

List Scenario blueprint versions

get

Returns the list of blueprint versions for a specific Scenario.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Responses
200
Scenario blueprint versions returned successfully.
application/json
get
GET /portal/api/bridge/scenarios/{scenarioId}/blueprints HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Scenario blueprint versions returned successfully.

{
  "blueprints": []
}

Get Scenario interface

get

Returns the interface of a specific Scenario.

Path parameters
scenarioIdintegerRequired
Query parameters
teamIdintegerOptional
Responses
200
Scenario interface returned successfully.
application/json
get
GET /portal/api/bridge/scenarios/{scenarioId}/interface HTTP/1.1
Host: <zone>.make.com
Accept: */*
200

Scenario interface returned successfully.

{
  "input": [],
  "output": []
}