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

CRUD Operations

PreviousTransactional Service NextWait Input

Was this helpful?

#144: 4.5 - Gen AI (KAI, Rephrase, Assist) + What's New (Notifications)

Change request updated 1 year ago

Returng a pagination list of bot's rest connectors

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/pagination

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

pageinteger · int32 · default: 1

The number of page and the default is 1

Example: 1

linesPerPageinteger · int32 · default: 5

The number of services per pages and the default is 5

Example: 1

orderBystring · default: updatedAt

Field want to ordernate, the default is 'updatedAt'

directionstring · default: DESC

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

searchTermsstring[]

Names or tags to filter the search

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/pagination'

200

400

401

403

404

409

422

500

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

Returning a list of possible words to autocomplete in search

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/quicksearch

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 · int64 · default: 6

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

Example: 1

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/quicksearch?searchTerm=text'

200

400

401

403

404

409

422

500

[
  "text"
]

Returns a list of all existing bot's rest connectors

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/list

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/list'

200

400

401

403

404

409

422

500

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

Retrieves a rest connector, by ID.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

serviceUUIDstringrequired

A valid service Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}'

200

400

401

403

404

409

422

500

{
  "name": "text",
  "description": "text",
  "requestType": "GET",
  "url": "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",
  "uuid": "text",
  "updatedAt": "2025-02-22T16:42:31.282Z",
  "updatedBy": "text",
  "headers": [
    {
      "header": "text",
      "value": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Create a new Rest Connector

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

namestringrequired

Name of the rest connector

descriptionstring

Description of the rest connector

requestTypestring · enumrequired

The used RequestType

Options: GET, POST, PUT, DELETE

urlstringrequired

Url of the rest connector

contentTypestring · enumrequired

Content Type of the request

Options: NONE, JSON, XML, FORM_DATA, URL_ENCODED

authTypestring · enumrequired

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

Options: AUTH_NONE, AUTH_BASIC, AUTH_BEARER, AUTH_OAUTH

grantTypestring · enum

Grant type to be used with oAuth Method

Options: CLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKEN

basicTokenstring

Basic Token for Basic Auth Header

bearerTokenstring

Bearer Token for Bearer Token Auth Header

clientIdstring

Client Id to be used with oAuth Method

clientSecretstring

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

oauthUrlstring

URL for authentication with oAuth Method

authUsernamestring

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

authPasswordstring

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

headersobject[]

Headers of the rest connector

tagsobject[]

Tags of the rest connector

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","requestType":"GET","url":"text","contentType":"NONE","authType":"AUTH_NONE","grantType":"CLIENT_CREDENTIALS","body":"text","output":"text","headers":[{"header":"text","value":"text"}],"tags":[{"name":"text"}]}'

201

400

401

403

404

409

422

500

{
  "uuid": "text"
}

Created

Updates an existing rest connector

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

serviceUUIDstringrequired

A valid service Uuid

Body

namestringrequired

Name of the rest connector

descriptionstring

Description of the rest connector

requestTypestring · enumrequired

The used RequestType

Options: GET, POST, PUT, DELETE

urlstringrequired

Url of the rest connector

contentTypestring · enumrequired

Content Type of the request

Options: NONE, JSON, XML, FORM_DATA, URL_ENCODED

authTypestring · enumrequired

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

Options: AUTH_NONE, AUTH_BASIC, AUTH_BEARER, AUTH_OAUTH

grantTypestring · enum

Grant type to be used with oAuth Method

Options: CLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKEN

basicTokenstring

Basic Token for Basic Auth Header

bearerTokenstring

Bearer Token for Bearer Token Auth Header

clientIdstring

Client Id to be used with oAuth Method

clientSecretstring

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

oauthUrlstring

URL for authentication with oAuth Method

authUsernamestring

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

authPasswordstring

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

headersobject[]

Headers of the rest connector

tagsobject[]

Tags of the rest connector

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","requestType":"GET","url":"text","contentType":"NONE","authType":"AUTH_NONE","grantType":"CLIENT_CREDENTIALS","body":"text","output":"text","headers":[{"header":"text","value":"text"}],"tags":[{"name":"text"}]}'

200

400

401

403

404

409

422

500

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

Symbolically deletes an existing rest connector

delete

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

serviceUUIDstringrequired

A valid service Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}'

204

400

401

403

404

409

422

500

No body

No Content