Your own application

Connect an application, a platform or a back office you own through the Azimea API, and what to agree with your developer.

What it brings

Your people, as contacts, with your own fields and their consent: one at a time, or up to 1,000 in one call.
What they do, as events with your own names and properties: these start, stop and branch flows, and can count as conversions.
Your application’s own emails (codes, confirmations, alerts), sent through Azimea and tracked like the rest.
Statuses back in your application through signed webhooks, if it needs to know what happened to an email.

Requirements

What	Why
A developer with access to your application’s code	The application has to call the API when something happens.
An Azimea owner or admin	Only they can create API keys.
A verified sending domain	Every email leaves from it, whatever started it.

Install and connect

1. Agree on the events

Before any code, write down the moments that matter in your application, one event for each, named in lowercase with dots. For example, for an onboarding in steps:

Event	When your application sends it	What Azimea does with it
`application.started`	Someone begins the sign-up	Starts the reminder flow
`documents.submitted`	They send what was missing	Stops the reminders
`account.activated`	The account is ready	Starts the welcome flow; counts as a conversion

If your product is a typical subscription app, the suggested product events (user.signed_up, user.activated, trial.ending, subscription.started) already fit the ready-made flows.

2. Create the key

In Settings › API keys, create a key named after the application and tick only what it uses: contacts:write for contacts, events:write for events, emails:send for its own emails. Give it to the developer through a password manager, not by email or chat: it is shown only once.

Start in a sandbox: its keys start with azm_test_, and nothing sent from it reaches anyone.

3. The developer connects the application

Everything the developer needs, with code samples, is in Connect your own system.

4. Check that data arrives, then build on it

New people appear in Contacts, with the fields you agreed.
The event names appear in Settings › Events, with their properties.
Mark the events that are results as conversions there.
Create the flows that start on them, test them, then publish.

Statuses

Where	Shown	What it means
Settings › API keys	Last used …	The application is calling Azimea with this key.
Settings › API keys	Not used yet	No call arrived with this key: check that the application has it.
Settings › Events	An event name with a count	Events with that name arrived in the last 30 days.

Troubleshooting

Symptom	Likely cause	Fix
The application gets `401`	The key is wrong, revoked or expired.	Create a new key and replace it in the application.
The application gets `403`	The key lacks a permission, such as `events:write`.	Create a key with the permission the call needs.
The application gets `429`	More than 600 calls a minute with this key.	Send in batches: up to 100 events or 1,000 contacts in one call.
An event arrived but the flow did not start	The flow is not published, or its Only when filter does not match.	Open the flow and check its trigger.
People get no marketing emails	They were sent without consent.	Send their consent with the contact, with its proof. See consent statuses.

Every error code is listed in error codes.

Disconnect

Revoke the key in Settings › API keys: it stops working at once. Contacts and events already received stay in Azimea.