Transactional Service

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

API SUBPATH: eva-transactional-service

Pagination and Listing

CRUD Operations

PreviousTraining NextRest Connector

Was this helpful?

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

Change request updated 1 year ago

Paginates through a bot's Transactional Services

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/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}/services/pagination'

200

400

401

403

404

409

422

500

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

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

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}/services/quicksearch?searchTerm=text'

200

400

401

403

404

409

422

500

[
  "text"
]

Retrieves a list containing all Transactional Services from a Bot.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/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}/services/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 detailed information from a service.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{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}/services/{serviceUUID}'

200

400

401

403

404

409

422

500

{
  "name": "text",
  "description": "text",
  "webhook": "text",
  "uuid": "text",
  "updatedAt": "2025-02-22T16:43:43.118Z",
  "updatedBy": "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"
    }
  ],
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Create a new Service.

post

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

namestringrequired

Name of the transactional service

descriptionstring

Description of the transactional service

webhookstringrequired

Webhook of the transactional service

headersobject[]

Headers of the transactional service

contentobject[]required

Content of the transactional service

tagsobject[]

Tags of the transactional service

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services' \
  --header 'Content-Type: application/json' \
  --data '{"name":"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"}]}'

201

400

401

403

404

409

422

500

{
  "uuid": "text"
}

Created

Updates an existing Service.

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{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 transactional service

descriptionstring

Description of the transactional service

webhookstringrequired

Webhook of the transactional service

headersobject[]

Headers of the transactional service

contentobject[]required

Content of the transactional service

tagsobject[]

Tags of the transactional service

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"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"}]}'

200

400

401

403

404

409

422

500

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

Removes an existing Service.

delete

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{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}/services/{serviceUUID}'

204

400

401

403

404

409

422

500

No body

No Content