Transactional Service
The Transactional Service API handles all transactional services used in your flows.
Pagination and Listing
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
The number of page and the default is 1
1Example: 1The number of services per pages and the default is 5
5Example: 1Field want to ordernate, the default is 'updatedAt'
updatedAtDirection of ordenation, ASC or DESC. The default is DESC
DESCNames or tags to filter the search
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/pagination HTTP/1.1
Host:
Accept: */*
{
"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,
"content": [
{
"uuid": "text",
"name": "text",
"flows": [
{
"uuid": "text",
"name": "text"
}
],
"tags": [
{
"name": "text"
}
],
"updatedAt": "2025-07-01T01:42:37.336Z",
"updatedBy": "text",
"user": {
"image": "text",
"username": "text"
}
}
],
"number": 1,
"empty": true
}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.
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Word or part of word to get suggestion names of transactional services
The limit of suggestions names in the response. The default value is 6
6Example: 1GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/quicksearch?searchTerm=text HTTP/1.1
Host:
Accept: */*
[
"text"
]A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/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
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid service Uuid
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID} HTTP/1.1
Host:
Accept: */*
{
"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"
}
],
"uuid": "text",
"flows": [
{
"uuid": "text",
"name": "text"
}
],
"updatedAt": "2025-07-01T01:42:37.336Z",
"updatedBy": "text"
}A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A body containing all necessary data to create a new Transactional Service
Name of the transactional service
Description of the transactional service
Webhook of the transactional service
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 309
{
"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"
}
]
}{
"uuid": "text"
}A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid service Uuid
A body containing all necessary data to create a new Transactional Service
Name of the transactional service
Description of the transactional service
Webhook of the transactional service
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 309
{
"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"
}
]
}{
"message": "text",
"data": "text"
}A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid service Uuid
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID} HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?