Register a UI Extension

POST

/ui-extensions

Last modified:2026-05-22 03:09:13

OperationId:createUiExtension

Registers a new Horizon extension. id is client-chosen and must be kebab-case (^[a-z0-9]+(-[a-z0-9]+)*$), max 255 chars. module_scope must be camelCase (^[a-zA-Z][a-zA-Z0-9]*$). version must be semver (^\d+\.\d+\.\d+$). remote_entry_url and icon_url must be valid URLs. Returns 202 Accepted — read the new extension back via GET /ui-extensions/{id} once the SBUS consumer has persisted it.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted

application/json

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Access Denied

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/ui-extensions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
        "id": "ucaas-extension-demo",
        "name": "UCAAS demo app",
        "remote_entry_url": "https:\/\/core1-phx.al.nseng.dev\/remote-demo-app\/remoteEntry.js",
        "module_scope": "ucaasExtensionDemo",
        "version": "1.0.1",
        "enabled": "yes",
        "description": "First test demo remote app",
        "author": "NetSapiens",
        "created_at": "2026-05-21 21:51:19",
        "updated_at": "2026-05-22 03:01:52",
        "created_by": null
    }'

Response Example

202 - Example 1

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-05-22 03:09:13

List UI Extensions

Get a UI Extension