Integrate your platform with Ordina, step by step
An end-to-end walkthrough for a platform that wants Ordina's Secretary on its own site, answering from its own data, with leads flowing back.
This walkthrough is for a platform that wants a Secretary on its own website and channels, answering from the platform's own data. The example is a courier company, but the same steps fit any platform: a parts supplier, a clinic system, a school portal, a property listing site.
- Set up the businessYour account on Ordina.
- Push knowledgeFAQs and guides.
- Add actionsLive lookups.
- Approve and testIn the dashboard.
- Go liveWebsite, WhatsApp, more.
How the pieces fit
| Piece | Direction | What it does |
|---|---|---|
| Pushed knowledge | You to Ordina | Text the Secretary answers from: how your platform works, FAQs |
| Connected actions | Ordina calls you | Live lookups during a chat (figures, availability, status), and changes the customer confirms first |
| Webhooks | Ordina to you | Leads, bookings, orders and reviews as they happen |
| REST API | You read Ordina | Appointments and orders, on demand |
| Embed widget and channels | Customers | Where your visitors talk to the Secretary |
Ordina builds nothing specific to your platform. You write a few endpoints and calls; the business owner approves them.
Step 1: set up the business
- Create the business on Ordina (your own company, if the Secretary represents you) on the Business plan.
- Fill in the basics in the dashboard: name, what you do, contact details, and any services customers can book, such as a consultation call.
- Connect your platform: build the Connect to Ordina button and approve it as the owner, or, for a single business you run yourself, create a key in Integration, API keys and store it in your secrets manager.
Check it with GET /api/v1/me.
Step 2: push your knowledge
Send the pages a visitor would otherwise read before asking: how your service works, where you cover, what things cost, how to contact you. Your Terms, privacy and refund policies belong in the dashboard as documents the owner adds: pushed text is never treated as the business's own policy.
PUT /api/v1/knowledge/how-it-works
{ "title": "How sending a parcel works", "content": "..." }
Run it from a nightly job, or whenever the source page changes. Unchanged pushes cost nothing. See Push knowledge.
Step 3: add your actions
Pick the two or three questions your visitors ask most that need live data, and make one action for each. For a courier:
| Action | Parameters | Returns |
|---|---|---|
| track_shipment | tracking_number | Status, last scan, expected delivery date, link |
| quote_delivery | from_area, to_area, weight_kg | Price, currency and delivery time |
| list_service_areas | none, or a search term | The towns and areas you deliver to |
| create_support_ticket (a write action) | tracking_number, problem, summary; receives the customer's email | Opens a ticket, once the customer confirms |
Register each one with POST /api/v1/actions, and build the endpoints. See Connected actions for the request, the response, and the checklist.
Step 4: approve and test
The business owner (often you) opens Integration, Connected actions, presses Test on each action with real values, then Switch on. Then try it as a customer would, on the business's chat page or on its WhatsApp number if it has connected one:
- "Where is my parcel SC123456789?" should call track_shipment.
- "How much to send a 4 kg box from Riverside to Hillcrest?" should call quote_delivery.
- "Do you deliver on Sundays?" should answer from pushed knowledge, without a call.
- A tracking number you do not know should get an honest "not found" answer.
- "My parcel arrived damaged, can you look into it?" should ask for the tracking number and an email address if they are missing, then show the ticket for a yes.
Every call appears in the action's history, with the arguments the Secretary used.
Step 5: put the Secretary where your visitors are
- Your website: add the Book now widget, or link to the business's chat page. See Your website.
- WhatsApp, Instagram, Messenger, Telegram, email, phone calls: each is one integration in the dashboard. Lookups work on all of them; on a phone call the Secretary reads your figures out loud. Write actions work on every chat channel, not on phone calls yet.
Step 6: hear about leads and bookings
Subscribe a webhook to lead.created, booking.created and anything else you track, and send them into your CRM. To hear what came of each conversation your actions or intakes took part in, and what happened to each write the Secretary proposed, name the opt-in events too:
POST /api/v1/webhooks
{ "url": "https://example.com/ordina/events", "events": ["lead.created", "booking.created", "conversation.completed", "action.confirmed", "action.failed"] }
An endpoint your app makes receives the classic events without the customer's contact details, and opt-in events only about your own actions, intakes and the conversations they were used in. See Webhook events.
Go-live checklist
- The API key is in a secrets manager, not in code.
- Every endpoint verifies signatures and rejects old timestamps.
- Every lookup answers in well under 5 seconds and says "not found" plainly.
- Every write action answers within 10 seconds, changes nothing for a test call, and changes nothing twice for the same Idempotency-Key.
- Every action is tested and switched on in the dashboard.
- Pushed knowledge covers the questions visitors ask most.
- A webhook delivers leads to wherever your team works.
- Someone watches the actions' call history for failures in the first week.
What is not available yet
- Write actions on phone calls. On a call the Secretary only uses lookups.
- Write actions from AI assistants connected to the business (MCP).
- Proving a customer's email or phone with a one-time code.
verifiedmeans the channel proved it.
