Rest Connector

The Rest Connector API handles all rest connectors used in your flows. They share the transactional service subpath.

API SUBPATH: eva-transactional-service

Pagination and Listing

Returng a pagination list of bot's transactional services

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1

linesPerPageinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt

directionstringOptional

Direction of ordenation, ASC or DESC. The default is DESC

Default: DESC

searchTermsstring[]Optional

Names or tags to filter the search

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/pagination HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "unpaged": true,
    "offset": 1,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ],
      "tags": [
        {
          "name": "text"
        }
      ],
      "updatedAt": "text",
      "updatedBy": "text",
      "user": {
        "image": "text",
        "username": "text"
      }
    }
  ],
  "number": 1,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Returning a list of possible words to autocomplete in search

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

searchTermstringRequired

Word or part of word to get suggestion names of transactional services

limitinteger · int64Optional

The limit of suggestions names in the response. The default value is 6

Default: 6Example: 1

Responses

200

Ok

*/*

Responsestring[]

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Returng a list of bot's transactional services not removed

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/list HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "content": [
        {
          "id": "text",
          "option": "text",
          "expressionCode": "text",
          "connectedTo": "text",
          "buttonText": "text",
          "buttonType": "text",
          "urlRedirect": true,
          "buttonUrl": "text",
          "cockpitUUID": "text"
        }
      ],
      "tags": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

CRUD Operations

Create new services

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

A body containing all necessary data to create a new Transactional Service

namestringRequired

Name of the rest connector

descriptionstringOptional

Description of the rest connector

requestTypestring · enumRequired

The used RequestType

Possible values:

urlstringRequired

Url of the rest connector

contentTypestring · enumRequired

Content Type of the request

Possible values:

authTypestring · enumRequired

Enum describing if cell uses an auth method, and which.

Possible values:

grantTypestring · enumOptional

Grant type to be used with oAuth Method

Possible values:

basicTokenstringOptional

Basic Token for Basic Auth Header

bearerTokenstringOptional

Bearer Token for Bearer Token Auth Header

clientIdstringOptional

Client Id to be used with oAuth Method

clientSecretstringOptional

Client Secret to be used with oAuth Method and grant type 'client_credentials'

oauthUrlstringOptional

URL for authentication with oAuth Method

authUsernamestringOptional

Username to be used with oAuth Method and grant type 'password'

authPasswordstringOptional

Password to be used with oAuth Method and grant type 'password'

bodystringRequired

Body of the rest connector

outputstringRequired

Expected parsing of output of the rest connector

Responses

201

Created

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 389

{
  "name": "text",
  "description": "text",
  "requestType": "GET",
  "url": "text",
  "headers": [
    {
      "header": "text",
      "value": "text"
    }
  ],
  "contentType": "NONE",
  "authType": "AUTH_NONE",
  "grantType": "CLIENT_CREDENTIALS",
  "basicToken": "text",
  "bearerToken": "text",
  "clientId": "text",
  "clientSecret": "text",
  "oauthUrl": "text",
  "authUsername": "text",
  "authPassword": "text",
  "body": "text",
  "output": "text",
  "tags": [
    {
      "name": "text"
    }
  ]
}

{
  "uuid": "text"
}

Find a service

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

serviceUUIDstringRequired

A valid service Uuid

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID} HTTP/1.1
Host: 
Accept: */*

{
  "name": "text",
  "description": "text",
  "requestType": "GET",
  "url": "text",
  "headers": [
    {
      "header": "text",
      "value": "text"
    }
  ],
  "contentType": "NONE",
  "authType": "AUTH_NONE",
  "grantType": "CLIENT_CREDENTIALS",
  "basicToken": "text",
  "bearerToken": "text",
  "clientId": "text",
  "clientSecret": "text",
  "oauthUrl": "text",
  "authUsername": "text",
  "authPassword": "text",
  "body": "text",
  "output": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "uuid": "text",
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "updatedAt": "2025-05-09T11:57:19.230Z",
  "updatedBy": "text"
}

Update service

put

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

serviceUUIDstringRequired

A valid service Uuid

Body

A body containing all necessary data to create a new Transactional Service

namestringRequired

Name of the rest connector

descriptionstringOptional

Description of the rest connector

requestTypestring · enumRequired

The used RequestType

Possible values:

urlstringRequired

Url of the rest connector

contentTypestring · enumRequired

Content Type of the request

Possible values:

authTypestring · enumRequired

Enum describing if cell uses an auth method, and which.

Possible values:

grantTypestring · enumOptional

Grant type to be used with oAuth Method

Possible values:

basicTokenstringOptional

Basic Token for Basic Auth Header

bearerTokenstringOptional

Bearer Token for Bearer Token Auth Header

clientIdstringOptional

Client Id to be used with oAuth Method

clientSecretstringOptional

Client Secret to be used with oAuth Method and grant type 'client_credentials'

oauthUrlstringOptional

URL for authentication with oAuth Method

authUsernamestringOptional

Username to be used with oAuth Method and grant type 'password'

authPasswordstringOptional

Password to be used with oAuth Method and grant type 'password'

bodystringRequired

Body of the rest connector

outputstringRequired

Expected parsing of output of the rest connector

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 389

{
  "name": "text",
  "description": "text",
  "requestType": "GET",
  "url": "text",
  "headers": [
    {
      "header": "text",
      "value": "text"
    }
  ],
  "contentType": "NONE",
  "authType": "AUTH_NONE",
  "grantType": "CLIENT_CREDENTIALS",
  "basicToken": "text",
  "bearerToken": "text",
  "clientId": "text",
  "clientSecret": "text",
  "oauthUrl": "text",
  "authUsername": "text",
  "authPassword": "text",
  "body": "text",
  "output": "text",
  "tags": [
    {
      "name": "text"
    }
  ]
}

{
  "message": "text",
  "data": "text"
}

Removes service

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

serviceUUIDstringRequired

A valid service Uuid

Responses

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

HTTPcURLJavaScriptPython

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID} HTTP/1.1
Host: 
Accept: */*

No content