Integrate your platform with Ordina, step by step

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 salary data site, but the same steps fit any platform: a clinic system, a school portal, a property listing site.

1. Set up the businessYour account on Ordina.
2. Push knowledgeFAQs and policies.
3. Add actionsLive lookups.
4. Approve and testIn the dashboard.
5. 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, policies, FAQs
Connected actions	Ordina calls you	Live lookups during a chat: figures, availability, status
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

1. Create the business on Ordina (your own company, if the Secretary represents you) on the Pro or Business plan.
2. Fill in the basics in the dashboard: name, what you do, contact details, and any services customers can book, such as a consultation call.
3. Open Integration, then API keys, and create a key for your platform. 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 data is collected, what you cover, privacy, pricing for any paid products, how to contact you.

PUT /api/v1/knowledge/how-it-works
{ "title": "How our salary data 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 salary site:

Action	Parameters	Returns
lookup_salary	role, level, location	Median, percentiles, entries, date, link
compare_offer	role, level, location, monthly_pay	Where that pay sits, as a percentile
list_roles	none, or a search term	Exact role names you have data for

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 WhatsApp:

• "What does a senior data scientist earn in Abuja?" should call lookup_salary.
• "Is 600k good for a mid-level PM in Lagos?" should call compare_offer.
• "How do you verify salaries?" should answer from pushed knowledge, without a call.
• A role you have no data for should get an honest "not enough data" answer.

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: each is one integration in the dashboard. Actions and knowledge work the same on every text channel.

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:

POST /api/v1/webhooks
{ "url": "https://example.com/ordina/events", "events": ["lead.created", "booking.created"] }

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 action answers in well under 5 seconds and says "not found" plainly.
• 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

• Phone calls do not use connected actions yet; the text channels do.
• Actions cannot change anything (submit, reserve, cancel).
• Connecting is by API key; a one-click "Connect to Ordina" sign-in for partner apps is planned.