Transactional Service

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

PreviousTraining NextRest Connector

Last updated 1 year ago

Was this helpful?

Paginates through a 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 · int32Optional

The number of page and the default is 1

Default: 1Example: 1

linesPerPageinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt

directionstringOptional

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

Default: DESC

searchTermsstring[]Optional

Names or tags to filter the search

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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-05-03T03:50:24.446Z",
      "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.

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 · int64Optional

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

Default: 6Example: 1

Responses

200

*/*

Responsestring[]

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Retrieves a list containing all Transactional Services from a Bot.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

Retrieves detailed information from 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

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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-05-03T03:50:24.446Z",
  "updatedBy": "text"
}

Removes an existing 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

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID} HTTP/1.1
Host: 
Accept: */*

No content

Create a new Service.

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

A body containing all necessary data to create a new Transactional Service

namestringRequired

Name of the transactional service

descriptionstringOptional

Description of the transactional service

webhookstringRequired

Webhook of the transactional service

Responses

201

Created

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

Updates an existing 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

A body containing all necessary data to create a new Transactional Service

namestringRequired

Name of the transactional service

descriptionstringOptional

Description of the transactional service

webhookstringRequired

Webhook of the transactional service

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

Transactional Service

Transactional Service

CRUD Operations

CRUD Operations

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.

Retrieves a list containing all Transactional Services from a Bot.

Retrieves detailed information from a service.

Removes an existing Service.

Create a new Service.

Updates an existing Service.

Pagination and Listing

CRUD Operations

Pagination and Listing

CRUD Operations

Paginates through a bot's Transactional Services

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.

Retrieves a list containing all Transactional Services from a Bot.

Retrieves detailed information from a service.

Removes an existing Service.

Create a new Service.

Updates an existing Service.