Developer API
Put Yavun inside your own platform.
If your product already has users, events or customers of its own, it can send through Yavun instead of building messaging from scratch. Your platform keeps its own interface; Yavun handles delivery.
SaaS products
Send the messages your own users depend on, without running mail and messaging infrastructure.
Marketplaces & portals
Keep both sides of your marketplace informed as bookings, orders and enquiries move.
Agencies & builders
Ship client projects on messaging you don't have to maintain.
What adding Yavun looks like.
Five steps from first conversation to live traffic. We walk through them with you, and you get the full developer documentation once your platform is registered.
1Register your platformA registered platform account
Tell us what your product does, what it will send and roughly how much. We set your platform up as a registered client.
2Collect your credentialsClient ID + secret key
You receive a client ID and a secret key for your platform. The secret is shown once, so store it in your server's secret manager, never in your front end or your repository.
3Authenticate from your serverServer-side authenticated calls
Your backend exchanges those credentials for an access token and sends it with each call. Calls are made server to server, so the secret never reaches a browser or a mobile app.
4Send in a test environmentA verified integration
Point your integration at test credentials first and run the messages your product actually sends, until the content, timing and data all look right.
5Go live and watch itLive traffic, visible results
Switch to live credentials, start with real traffic and follow delivery and engagement from your own dashboard or ours.
What your platform can do through the API.
01Send transactional messages
Confirmations, receipts, reminders and alerts triggered by what happens in your product.
02Send campaigns
Newsletters, announcements and updates to the audiences your platform already holds.
03Keep contacts in sync
Create and update contacts, lists and segments as your own records change.
04Reach more than the inbox
Email, WhatsApp and SMS from the same integration, on the channels you enable.
05Follow what happened
Delivery and engagement information flows back, so your product can act on it.
06Respect consent
Opt-ins and opt-outs carry across channels, so your platform stays on the right side of them.
A working example
Viteplan sends through Yavun.
Viteplan is a wedding invitation and guest-management platform. Couples use Viteplan's own interface for invitations, guest lists and RSVPs, and the messages those actions trigger are delivered through Yavun's API. Guests never see Yavun; the platform keeps its own experience end to end.
See the events pageSecurity
Keys, access and good practice.
- Each platform gets its own client ID and secret key, separate from anyone else's.
- Secrets belong on your server, in a secret manager, never in client-side code or version control.
- Keys can be rotated, and a key you believe is exposed can be revoked.
- Access is scoped to what your platform is approved to send.
- You stay the controller of your users' data; we process it to deliver what you send.
The full reference, including endpoints, payloads and error handling, is in the developer documentation shared with registered platforms.
Questions, answered.
Do I need to be a Yavun customer first?
Tell us about your platform and what it needs to send. We'll explain which plan fits before you build anything.
Where do I get the developer documentation?
It's shared with your team once your platform is registered, along with your test credentials.
Can I test before going live?
Yes. You build against test credentials, and switch to live ones when the integration is doing what you expect.
Who owns the contacts my platform sends to?
You do. They stay your users and your records; Yavun processes them to deliver the messages you ask for.
What if a secret key is exposed?
Tell us straight away. The key can be revoked and replaced, and we'll help you check what was sent with it.
Tell us what your platform needs to send.
A short conversation is usually enough to tell whether an integration makes sense, and what it would take.