Cloud Events Base is a Business Central extension by Origo that provides a cloud event messaging framework. External systems can send structured messages to Business Central through a REST API, and the extension processes them either synchronously (immediate response) or asynchronously (queued for background processing).
The extension supports a wide range of built-in message types for retrieving customer credit information, checking item availability and prices, working with sales documents, synchronising data, and discovering API metadata. It is fully extensible – partners can add new message types and implementation strategies without modifying the base code.
| Page | Description |
|---|---|
| Cloud Events Setup | Central configuration page for implementation strategies, credit-limit tolerance, and default language. |
| Cloud Event Messages | List of all cloud event messages with their processing status, request/response data, and task actions. |
| Cloud Events Integration | Operational log of cloud event integration activities, showing the source system, table, and timestamp for each event. Supports flagging records as reversed. |
| Cloud Events Storage | View and manage stored blob content associated with cloud events. Supports file import and export. |
| Cloud Event Message Editor | Inline editor for viewing and modifying the request payload of a cloud event message. |
| Cloud Event Request | FactBox that displays the incoming request data of the selected cloud event message. |
| Cloud Event Response | FactBox that displays the response data produced after a cloud event message has been processed. |
| Cloud Event Translations | Manage translation entries used by external systems to retrieve translated text for messages. |
| Cloud Events Field Accesses | Define and manage field-level read/write restrictions for users and Entra ID applications accessing the Cloud Events API. |
| Select Field | Lookup page for browsing and selecting a table field when setting up field access restrictions. |
| Select User or Application | Lookup page for selecting a Business Central user or Entra ID application when managing field access restrictions. |
| Select Translation Source | Lookup page for selecting a translation source to filter the Cloud Event Translations list. |
| Cloud Events Delete Setup | Configure which tables have their deleted records captured to the delete log, with optional JSON snapshots. |
| Cloud Events Delete Log | Read-only audit log of all deletions from tracked tables, including table, SystemId, timestamp, and user. |
| Cloud Events User Setup | Per-user configuration including system prompts and linked-record overrides for AI-powered message types. |
| Cloud Events User Setup Editor | Detailed editor for viewing and modifying a user's JSON configuration in the Cloud Events system. |
| Cloud Events User Setup FactBox | FactBox showing a quick overview of the current user's Cloud Events configuration. |
| MCP Chat Role Card | Card page for viewing and editing a single MCP chat role (persona) configuration. |
| MCP Chat Role List | List of available MCP chat roles (personas) that control AI assistant behaviour. |
| Caller Identity | Displays the identity and authentication details of the current API caller or user session. |
| Cloud Events Notes | List of all notification and note records in the Cloud Events system. |
| Cloud Events Note Card | Card page for viewing and editing a single cloud event notification or note. |
| Cloud Events Note FactBox | FactBox showing the message thread associated with a cloud event notification. |
| Cloud Events Note Message | Page for composing or viewing a single message within a cloud event notification thread. |
| Cloud Events Memory | Company-level memory storage shared across all users in the Cloud Events system. |
| Cloud Events User Memory | Personal memory storage for the current user, not visible to other users. |
The following API pages are used programmatically by external integrations and are not opened directly by users:
| API Page | Endpoint | Description |
|---|---|---|
| Cloud Event Request Data API | /api/origo/cloudEvent/v1.0/requests |
Read-only endpoint that returns the original request payload for a processed message. Use the same message ID as tasks/queues. |
| Cloud Event Task API | /api/origo/cloudEvent/v1.0/tasks |
Synchronous processing – creates and processes a message immediately, returning the result in one call. |
| Cloud Event Queue API | /api/origo/cloudEvent/v1.0/queues |
Asynchronous processing – queues a message for background processing; use GetStatus to poll or subscribe to webhooks. |
| Cloud Event Response Data API | /api/origo/cloudEvent/v1.0/responses |
Read-only endpoint that returns the response data content for a processed message. |
| Document | Description |
|---|---|
| README | Project overview, message types, extensibility patterns, setup, and example scenarios. |
| API Reference | Complete REST API reference for the Cloud Event Queue, Task, and Data endpoints. |
| Data Message Types | Documentation for Data.Records.Get, Data.Records.Set, Data.RecordIds.Get, CSV.Records.Get, and Data.Totals.Get message types. |
| Data.Totals.Get | Aggregates Decimal SumIndexFields across all matching records using CalcSums. Returns field totals as a single JSON object. |
| CSV.Records.Get | Exports all matching records from a specified table as a UTF-8 CSV file in Open Mirroring format. Supports continuation for large exports via continueFromRecordId. |
| Events & Webhooks | External Business Events, webhook notifications, and integration event reference. |
| Field Access Restrictions | User-level field access restrictions for Data.Records.Get/Set operations. |
| Metadata Message Types | Documentation for Help.* message types (MessageTypes, Implementation, Tables, Fields, Permissions). |
| Sales Message Types | Documentation for Customer (credit limit, sales history), Item (availability, price), and Sales message types (order lifecycle: Release, Reopen, Post, Statistics; PDF documents for invoices, credit memos, shipments, and return receipts). |
| Purchase Message Types | Documentation for Purchase Order message types: lifecycle management including Release, Reopen, Statistics, and Post. |
| Finance Message Types | Documentation for Finance message types: General Journal posting, Chart of Accounts, G/L Budget, and G/L Entry query operations. |
| Setup Reference | Configuration reference for Cloud Events Setup, interfaces, and extension points. |
| ChangeLog Message Types | Documentation for ChangeLog.Field.History, ChangeLog.Field.Restore, and ChangeLog.Field.Enabled message types, including Write Guard modes and safety guards. |
| Incoming Document Message Types | Documentation for incoming document message types: create, attach, process, and retrieve incoming documents. |
| User Message Types | Documentation for User.Notification message type for sending user notifications with customizable titles, messages, and links. |
| Integration Skill Guide (SKILL.md) | AI coding skill guide for integrators building against the Cloud Events API. |
© Origo – Cloud Events Base Extension