Transactional Service

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

API SUBPATH: eva-transactional-service

Pagination and Listing

Paginates through a bot's Transactional Services

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/pagination

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

firstboolean

lastboolean

numberOfElementsinteger (int32)

sortSort (object)

sizeinteger (int32)

contentarray of TransactionalServicePageDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/pagination', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageSize": 0,
    "unpaged": false,
    "paged": false,
    "pageNumber": 0,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    },
    "offset": 0
  },
  "first": false,
  "last": false,
  "numberOfElements": 0,
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "size": 0,
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ],
      "tags": [
        {
          "name": "text"
        }
      ],
      "updatedAt": "2024-12-04T08:31:04.911Z",
      "updatedBy": "text",
      "user": {
        "image": "text",
        "username": "text"
      }
    }
  ],
  "number": 0,
  "empty": false
}

Searches (greedily) for any Transaction Service names that exists in a bot, matching the typed term, left-to-right, and returns a list of up to 6 Strings, ordered alphabetically.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/quicksearch

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/quicksearch?searchTerm=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

Retrieves a list containing all Transactional Services from a Bot.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/list

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Response

200400401403404409422500

Ok

Body

*/*

dataarray of TransactionalServiceContentListDTO (object)

List with of transactional service

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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

CRUD Operations

Retrieves detailed information from a service.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

serviceUUID*string

A valid service Uuid

Response

200400401403404409422500

Ok

Body

*/*

name*string

Name of the transactional service

descriptionstring

Description of the transactional service

webhook*string

Webhook of the transactional service

headersarray of HeaderDTO (object)

Headers of the transactional service

content*array of ContentDTO (object)

Content of the transactional service

tagsarray of TagDTO (object)

Tags of the transactional service

uuidstring

UUID of the transactional service

flowsarray of FlowDTO (object)

Flows when the transactional service is used

updatedAtstring (date-time)

Datetime of last transactional service update

updatedBystring

User uuid of last transactional service update

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "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": false,
      "buttonUrl": "text",
      "cockpitUUID": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "uuid": "text",
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "updatedAt": "2024-12-04T08:31:04.911Z",
  "updatedBy": "text"
}

Create a new Service.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

name*string

Name of the transactional service

descriptionstring

Description of the transactional service

webhook*string

Webhook of the transactional service

headersarray of HeaderDTO (object)

Headers of the transactional service

content*array of ContentDTO (object)

Content of the transactional service

tagsarray of TagDTO (object)

Tags of the transactional service

Response

201400401403404409422500

Created

Body

*/*

uuidstring

UUID of the transactional service

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "content": [
        {
          "buttonText": "text",
          "buttonType": "text",
          "buttonUrl": "text",
          "cockpitUUID": "text",
          "connectedTo": "text",
          "expressionCode": "text",
          "id": "text",
          "option": "text",
          "urlRedirect": false
        }
      ],
      "name": "text",
      "webhook": "text"
    }),
});
const data = await response.json();

Response

201400401403404409422500

{
  "uuid": "text"
}

Updates an existing Service.

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

serviceUUID*string

A valid service Uuid

Body

application/json

name*string

Name of the transactional service

descriptionstring

Description of the transactional service

webhook*string

Webhook of the transactional service

headersarray of HeaderDTO (object)

Headers of the transactional service

content*array of ContentDTO (object)

Content of the transactional service

tagsarray of TagDTO (object)

Tags of the transactional service

Response

200400401403404409422500

Ok

Body

*/*

messagestring

Message 'OK'

datastring

Message 'Service Updated'

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "content": [
        {
          "buttonText": "text",
          "buttonType": "text",
          "buttonUrl": "text",
          "cockpitUUID": "text",
          "connectedTo": "text",
          "expressionCode": "text",
          "id": "text",
          "option": "text",
          "urlRedirect": false
        }
      ],
      "name": "text",
      "webhook": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

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

Removes an existing Service.

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

serviceUUID*string

A valid service Uuid

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}