Transactional Service

The Transactional Service API handles all transactional services used in your flows.

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 · int32 · default: 1optional

The number of page and the default is 1

Example: 1

linesPerPageinteger · int32 · default: 5optional

The number of services per pages and the default is 5

Example: 1

orderBystring · default: "updatedAt"optional

Field want to ordernate, the default is 'updatedAt'

directionstring · default: "DESC"optional

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

searchTermsstring[]optional

Names or tags to filter the search

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

409

422

500

200

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

Ok

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

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

Example: 1

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

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

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

409

422

500

200

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

Ok

CRUD Operations

Create new services

post

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

namestringrequired

Name of the transactional service

descriptionstringoptional

Description of the transactional service

webhookstringrequired

Webhook of the transactional service

headersobject[]optional

Headers of the transactional service

contentobject[]required

Content of the transactional service

tagsobject[]optional

Tags of the transactional service

authTypestring · enumoptional

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

Options: AUTH_NONE, AUTH_BASIC, AUTH_BEARER, AUTH_OAUTH

basicTokenstringoptional

Basic Token for Basic Auth Header

bearerTokenstringoptional

Bearer Token for Bearer Token Auth Header

oauthUrlstringoptional

URL for authentication with oAuth Method

grantTypestring · enumoptional

Grant type to be used with oAuth Method

Options: CLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKEN

clientIdstringoptional

Client Id to be used with oAuth Method

clientSecretstringoptional

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

authUsernamestringoptional

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

authPasswordstringoptional

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "webhook": "text",
    "headers": [
      {
        "header": "text",
        "value": "text"
      }
    ],
    "content": [
      {
        "id": "text",
        "option": "text",
        "expressionCode": "text",
        "connectedTo": "text",
        "buttonText": "text",
        "buttonType": "text",
        "urlRedirect": true,
        "buttonUrl": "text",
        "cockpitUUID": "text"
      }
    ],
    "tags": [
      {
        "name": "text"
      }
    ],
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  }'

201

400

401

403

404

409

422

500

201

{
  "uuid": "text"
}

Created

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

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

409

422

500

200

{
  "name": "text",
  "description": "text",
  "webhook": "text",
  "headers": [
    {
      "header": "text",
      "value": "text"
    }
  ],
  "content": [
    {
      "id": "text",
      "option": "text",
      "expressionCode": "text",
      "connectedTo": "text",
      "buttonText": "text",
      "buttonType": "text",
      "urlRedirect": true,
      "buttonUrl": "text",
      "cockpitUUID": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "authType": "AUTH_NONE",
  "basicToken": "text",
  "bearerToken": "text",
  "oauthUrl": "text",
  "grantType": "CLIENT_CREDENTIALS",
  "clientId": "text",
  "clientSecret": "text",
  "authUsername": "text",
  "authPassword": "text",
  "uuid": "text",
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "updatedAt": "2025-03-28T10:01:16.389Z",
  "updatedBy": "text"
}

Ok

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

namestringrequired

Name of the transactional service

descriptionstringoptional

Description of the transactional service

webhookstringrequired

Webhook of the transactional service

headersobject[]optional

Headers of the transactional service

contentobject[]required

Content of the transactional service

tagsobject[]optional

Tags of the transactional service

authTypestring · enumoptional

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

Options: AUTH_NONE, AUTH_BASIC, AUTH_BEARER, AUTH_OAUTH

basicTokenstringoptional

Basic Token for Basic Auth Header

bearerTokenstringoptional

Bearer Token for Bearer Token Auth Header

oauthUrlstringoptional

URL for authentication with oAuth Method

grantTypestring · enumoptional

Grant type to be used with oAuth Method

Options: CLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKEN

clientIdstringoptional

Client Id to be used with oAuth Method

clientSecretstringoptional

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

authUsernamestringoptional

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

authPasswordstringoptional

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "webhook": "text",
    "headers": [
      {
        "header": "text",
        "value": "text"
      }
    ],
    "content": [
      {
        "id": "text",
        "option": "text",
        "expressionCode": "text",
        "connectedTo": "text",
        "buttonText": "text",
        "buttonType": "text",
        "urlRedirect": true,
        "buttonUrl": "text",
        "cockpitUUID": "text"
      }
    ],
    "tags": [
      {
        "name": "text"
      }
    ],
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  }'

200

400

401

403

404

409

422

500

200

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

Ok

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

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

204

400

401

403

404

409

422

500

204

No body

No Content