Create workflow connection

POST

/api/admin/workflow/connections

const url = 'https://example.com/api/admin/workflow/connections';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Camunda Production","baseUrl":"https://camunda.example.com/api","callbackBaseUrl":"https://cmbox.example.com","auth":{"type":"bearer","token":"secret-token","username":"admin","password":"example","apiKey":"example","headerName":"X-API-Key"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/admin/workflow/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Camunda Production", "baseUrl": "https://camunda.example.com/api", "callbackBaseUrl": "https://cmbox.example.com", "auth": { "type": "bearer", "token": "secret-token", "username": "admin", "password": "example", "apiKey": "example", "headerName": "X-API-Key" } }'

Creates a new workflow connection

Authorizations

bearerAuth

Request Body

application/json

object

name

required

Human-readable connection name

string

Example

Camunda Production

baseUrl

required

Base URL of the workflow engine API

string format: uri

Example

https://camunda.example.com/api

callbackBaseUrl

required

Base URL for CM Box callbacks

string format: uri

Example

https://cmbox.example.com

auth

required

object

type

required

Authentication type

string

Allowed values: bearer basic api_key none

Example

bearer

token

Bearer token (for type: bearer)

string

Example

secret-token

username

Username (for type: basic)

string

Example

admin

password

Password (for type: basic)

string

apiKey

API key (for type: api_key)

string

headerName

Header name for API key (default: X-API-Key)

string

Example

X-API-Key

Responses

201

Connection created successfully

application/json

object

required

Unique connection identifier

string

name

required

Human-readable connection name

string

baseUrl

required

Base URL of the workflow engine API

string format: uri

callbackBaseUrl

required

Base URL for CM Box callbacks

string format: uri

auth

required

object

type

required

Authentication type

string

Allowed values: bearer basic api_key none

token

Bearer token (for type: bearer)

string

username

Username (for type: basic)

string

password

Password (for type: basic)

string

apiKey

API key (for type: api_key)

string

headerName

Header name for API key (default: X-API-Key)

string

Example

{
  "id": "camunda-prod",
  "name": "Camunda Production",
  "baseUrl": "https://camunda.example.com/api",
  "callbackBaseUrl": "https://cmbox.example.com",
  "auth": {
    "type": "bearer",
    "token": "secret-token",
    "username": "admin",
    "headerName": "X-API-Key"
  }
}

400

Invalid request body

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}

409

Connection with this ID already exists

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}

500

Internal server error

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}