Rest Connector
The Rest Connector API handles all rest connectors used in your flows. They share the transactional service subpath.
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}/rest-connectors/pagination HTTP/1.1
Host:
Accept: */*
{
"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
}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}/rest-connectors/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}/rest-connectors/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 body containing all necessary data to create a new Transactional Service
Name of the rest connector
Description of the rest connector
The used RequestType
Url of the rest connector
Content Type of the request
Enum describing if cell uses an auth method, and which.
Grant type to be used with oAuth Method
Basic Token for Basic Auth Header
Bearer Token for Bearer Token Auth Header
Client Id to be used with oAuth Method
Client Secret to be used with oAuth Method and grant type 'client_credentials'
URL for authentication with oAuth Method
Username to be used with oAuth Method and grant type 'password'
Password to be used with oAuth Method and grant type 'password'
Body of the rest connector
Expected parsing of output of the rest connector
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 389
{
"name": "text",
"description": "text",
"requestType": "GET",
"url": "text",
"headers": [
{
"header": "text",
"value": "text"
}
],
"contentType": "NONE",
"authType": "AUTH_NONE",
"grantType": "CLIENT_CREDENTIALS",
"basicToken": "text",
"bearerToken": "text",
"clientId": "text",
"clientSecret": "text",
"oauthUrl": "text",
"authUsername": "text",
"authPassword": "text",
"body": "text",
"output": "text",
"tags": [
{
"name": "text"
}
]
}{
"uuid": "text"
}A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid service Uuid
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID} HTTP/1.1
Host:
Accept: */*
{
"name": "text",
"description": "text",
"requestType": "GET",
"url": "text",
"headers": [
{
"header": "text",
"value": "text"
}
],
"contentType": "NONE",
"authType": "AUTH_NONE",
"grantType": "CLIENT_CREDENTIALS",
"basicToken": "text",
"bearerToken": "text",
"clientId": "text",
"clientSecret": "text",
"oauthUrl": "text",
"authUsername": "text",
"authPassword": "text",
"body": "text",
"output": "text",
"tags": [
{
"name": "text"
}
],
"uuid": "text",
"flows": [
{
"uuid": "text",
"name": "text"
}
],
"updatedAt": "2025-07-18T22:14:28.661Z",
"updatedBy": "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 rest connector
Description of the rest connector
The used RequestType
Url of the rest connector
Content Type of the request
Enum describing if cell uses an auth method, and which.
Grant type to be used with oAuth Method
Basic Token for Basic Auth Header
Bearer Token for Bearer Token Auth Header
Client Id to be used with oAuth Method
Client Secret to be used with oAuth Method and grant type 'client_credentials'
URL for authentication with oAuth Method
Username to be used with oAuth Method and grant type 'password'
Password to be used with oAuth Method and grant type 'password'
Body of the rest connector
Expected parsing of output of the rest connector
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 389
{
"name": "text",
"description": "text",
"requestType": "GET",
"url": "text",
"headers": [
{
"header": "text",
"value": "text"
}
],
"contentType": "NONE",
"authType": "AUTH_NONE",
"grantType": "CLIENT_CREDENTIALS",
"basicToken": "text",
"bearerToken": "text",
"clientId": "text",
"clientSecret": "text",
"oauthUrl": "text",
"authUsername": "text",
"authPassword": "text",
"body": "text",
"output": "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}/rest-connectors/{serviceUUID} HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?