Developers

Connect your product to Ormuz.

Use APIs, events and user journeys to bring Ormuz into your application. Connect existing systems and keep custom work in your own services when needed.

Your application01
New business account

Alba Distribution

Pending activation
POST/v1/processes/:id/runs
Starts your onboarding process
ormuz
Coordinates the operation02
  1. Verify the company
  2. Apply your rules
  3. Approve the case
Event received by your applicationonboarding_case.approved
Your application updatedAccount active
Integration example · From API request to an updated application
Your application

Choose how your application takes part

Create and read public resources, start supported operations and receive business changes through documented events and webhooks.

01

Call Ormuz from my application

Read and manipulate public resources through stable IDs and contracts.

API
02

React to a business change

Consume documented events instead of polling operational systems.

Events
03

Connect my ERP or commerce platform

Use a host connector when a supported business system should remain the operational home.

Connector
04

Keep execution in my service

Materialise a typed External Task and let your service produce the result.

External Task
05

Build a reusable provider capability

Use the extension contract and governance published in Partner Docs.

Extension
API & events

Public objects on one side. Explicit events on the other.

Applications depend on the Ormuz business contract; extensions absorb provider-specific details.

Response · selected fieldsGET /v1/invoices/inv_abc123
{
  "id": "inv_abc123",
  "object": "invoice",
  "buyer_id": "pty_...",
  "currency": "eur",
  "status": "issued"
}
Event · selected payload fieldspayment.received
{
  "object": "payment",
  "id": "pay_abc123",
  "amount": 125000,
  "currency": "eur"
}
Dependency
Build against the business outcome, not every provider payload.

An invoice, a buyer or a payment keeps its public identity as the operation moves between systems.

Your services

Keep custom work where it belongs

Already have a service that performs a specialised calculation or internal check? Let the process hand it a task and wait for its result.

Your service claims the task and returns a validated result. Ormuz coordinates the steps before and after it.

External Task

Your logic, in your service.

  1. 1
    Ormuz

    Prepare the request

    The process creates a task with the information to handle.

  2. 2
    Your service

    Do the work

    Your service claims the task and returns its result.

  3. 3
    Ormuz

    Continue the process

    The result is validated before moving to the next step.

Integrate Ormuz

Start from the user journey, then choose the contracts you need.

Explore a participant journey in Journey; Platform Docs provides the exact endpoints, events and conventions to integrate it.