Execute one command | Cessy Builder Docs

const url = 'https://cessy.ai/api/rest/tenant-id/app-id/commands/commandType';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "success": true,
  "command": "CreateUserAccount",
  "eventsEmitted": 2,
  "events": [
    {
      "type": "UserCreated",
      "data": {}
    },
    {
      "type": "WelcomeEmailSent",
      "data": {}
    }
  ],
  "scopeKey": "user-12345",
  "warnings": [
    "Email service response delayed"
  ],
  "policyErrors": [
    {}
  ]
}

Executes a command from the published DomainConfig. Use the generated app OpenAPI document for the concrete request schema, required business fields, and response event types.

Authentication

AuthorizationBearer

Tenant/app API key or OAuth/JWT bearer token.

Path parameters

commandTypestringRequired

Command name from DomainConfig.commands.

Query parameters

workspaceIdstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

Request

This endpoint expects a map from strings to any.

Response

Command executed on an existing scope

successboolean

commandstring

eventsEmittedinteger>=0

eventslist of objects

scopeKeystring

warningslist of strings

policyErrorslist of maps from strings to any

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error