ANTE User ManualEndpoint Registry
The Endpoint Registry is a read-only reference catalog of the business events ANTE can broadcast to other systems, and the exact data each event carries. Use it to look up which events exist, what each one means, and the fields you can expect when an event fires.
Overview
ANTE groups its events by module (such as CRM, Projects, or HRIS). Each module contains one or more events — moments in your daily work, like a deal being won or a payroll run being finalized. Every event lists the fields it sends, so you always know what information travels with it.
This page is purely for looking things up. There is nothing to fill in, save, or change here — it is a catalog you browse and search.
Getting There
Go to Settings → Endpoint Registry.
Page Layout
At the top of the page you'll see:
- The title Endpoint Registry.
- A summary line showing the totals — the number of modules, events, and fields in the catalog.
- A search box on the right (placeholder text: Search endpoints, fields…).
Below that is the list of modules. Each module appears as a card you can expand or collapse:
- A coloured icon and the module name.
- A short description of what the module covers.
- A count of how many events that module has (for example, 3 events).
- A chevron (downward arrow) you click to open or close the card.
All module cards start open when you arrive on the page.
Inside a module
When a module card is open, it lists its events. Each event row shows:
- A small coloured dot.
- The event name (for example, Deal Won).
- A short description of when the event fires.
- The event's ID (for example,
crm.deal.won) — the technical name used by connected systems. - A chevron to expand the event and reveal its fields.
Event rows start collapsed — click one to see its field list.
Inside an event
When you expand an event, a table of its fields appears with these columns:
| Column | What it shows |
|---|---|
| Field Key | The short name of the field (for example, dealValue) |
| Label | A friendly name for the field (for example, Deal Value) |
| Type | The kind of value the field holds (see types below) |
| Description | A note explaining the field, when one is provided. A dash (—) means there is no description |
| Example | A sample value, when one is provided. A dash (—) means there is no example |
Field types you may see in the Type column:
- string — text (names, IDs, codes)
- number — a numeric value (amounts, quantities, counts)
- date — a date and time
- boolean — a true / false value
- object — a bundle of related values grouped together
- array — a list of items
Searching
Type in the search box to narrow the catalog. As you type, ANTE filters the list to events that match your text. It looks for your words in:
- the event name,
- the event ID,
- the event description, and
- the field keys and field labels inside each event.
A module also stays visible if your search text matches the module name itself.
If nothing matches, the page shows an "No endpoints match your search." message with an icon. Clear the search box to bring the full catalog back.
Modules and Events in the Catalog
The catalog currently covers the following modules and events.
CRM
Customer Relationship Management — deals, contacts, companies, and activities.
| Event | When it fires | ID |
|---|---|---|
| Deal Won | A CRM deal is moved to the Won stage | crm.deal.won |
| Deal Lost | A CRM deal is moved to the Lost stage | crm.deal.lost |
| Contact Created | A new contact is added to the CRM | crm.contact.created |
Projects
Project management — projects, milestones, tasks, and deliverables.
| Event | When it fires | ID |
|---|---|---|
| Project Created | A new project is created | project.created |
| Project Completed | A project status is set to Completed | project.completed |
| Task Completed | A task inside a project is marked as done | project.task.completed |
Purchasing
Purchase requests, purchase orders, and supplier management.
| Event | When it fires | ID |
|---|---|---|
| Purchase Order Approved | A purchase order completes the approval workflow | purchasing.po.approved |
| Purchase Request Submitted | A purchase request is submitted for approval | purchasing.pr.submitted |
HRIS
Human Resource Information System — employees, payroll, leave, and attendance.
| Event | When it fires | ID |
|---|---|---|
| Employee Onboarded | A new employee record is activated | hris.employee.onboarded |
| Leave Approved | A leave request is approved | hris.leave.approved |
| Payroll Processed | A payroll run is finalized | hris.payroll.processed |
Inventory
Inventory management — items, stock levels, warehouses, and adjustments.
| Event | When it fires | ID |
|---|---|---|
| Low Stock Alert | An item falls below its reorder threshold | inventory.item.low_stock |
| Stock Adjustment Posted | A stock adjustment is posted | inventory.adjustment.posted |
Process
Process orchestration — instances started, completed, steps triggered.
| Event | When it fires | ID |
|---|---|---|
| Process Instance Started | A new process instance is launched | process.instance.started |
| Process Instance Completed | A process instance reaches its final completed state | process.instance.completed |
Common Tasks
Looking up an event's fields
- Go to Settings → Endpoint Registry.
- Find the module you're interested in (or type part of the event name in the search box).
- Click the event row to expand it.
- Read the field table to see each field's key, label, type, and any description or example.
Finding which events a module has
- Open the page and locate the module card.
- The header shows the event count (for example, 2 events).
- If the card is collapsed, click its chevron to open it and list the events.
Tidying the view
- Click any module header to collapse or expand that whole module.
- Click any event row to collapse or expand its field table.
- Collapse modules you aren't using so the page stays focused on what you need.
Tips
- The summary line at the top (modules · events · fields) is a quick way to gauge how much the catalog covers.
- The event ID (like
hris.payroll.processed) is the exact name a connected system uses — note it down when you're coordinating an integration with your IT team. - Search matches field keys and labels too, so you can search by a piece of data (for example, currency) to find every event that carries it.
Related Pages
- Cloud Credentials — connect external storage, AI, and email services
- About — system information
💡 Note: The Endpoint Registry is a reference catalog only. Browsing it does not change any settings or data.