Usage

Calling an integration

GET  /list                                          integrations available to the tenant
POST /integration/:name/data                        proxy a data call
POST /integration/:name/notification/:template      send through the integration
POST /integration/:name/workflow/:workflow          trigger a workflow in the target system

The three proxy shapes cover what integrations are actually used for: moving data, sending a message, and starting a process on the other side.

Data calls

POST /integration/salesforce/data

The payload is forwarded to the integration’s configured endpoint with its credentials attached. Your code knows the integration’s name and the shape of the payload; it does not know the URL, the auth scheme, or the token.

Notification calls

POST /integration/:name/notification/:template

Sends through the third-party system using one of its templates — a vendor’s own transactional email, an internal messaging platform. Distinct from Notifications, which owns delivery semantics for channels the platform manages. Use this when the other side owns the template and the sending.

Workflow calls

POST /integration/:name/workflow/:workflow

Triggers a named process in the target system — an approval chain in a partner’s tooling, a provisioning run. Fire-and-forward: the target system owns the outcome.

Discovering what exists

GET /list

The inventory of integrations available to the tenant. It is accurate because it is what the runtime resolves against, unlike a wiki page listing what someone believed was connected in March.

Next

• Operations — credentials, tenancy and monitoring