Going further: connecting your own systems
Your product supplies the customer facts and business events; your marketing team owns the audience definitions, email content and journeys in maxclicks. Developers connect the two through the Public API, using the operations available for each resource.
Use this lesson to prepare the developer handoff: source identifiers, event definitions, template inputs, workspace access and the operations your product will call.
What your code drives, and what you build in the app
Your code can:
- create and update contacts and objects
- fire events, which start workflows and webhooks
- send a saved template to one recipient
- trigger, pause and unpause a workflow, and read its runs
- update, schedule and send a broadcast, and read its results
- create segments and count or list who matches them
- read back your schemas, attributes, domains, senders and topics
You build in the app:
- schemas and their attributes
- email content: templates, broadcast content, and the content inside a workflow's send email step
- workflows and forms
- sending domains, sender profiles and communication topics
- API keys
Agree on the data model and email inputs before implementing the integration. Your developer needs the schema slugs, stable field keys, event identifiers and template identifier, plus the expected behavior on retries. The reference for each resource defines the exact available operations.
Create a key
Open Settings, then Developers, then the API keys tab, and click Create API key. A name is optional and exists only to tell keys apart later.
The key is shown to you exactly once. Copy it then, because maxclicks never shows it again. A key is scoped to its workspace and inherits its owner's membership permissions; there are no granular scopes. Keep it in server-side configuration, and revoke it if exposed.
Hand over the reference
The Quickstart uses a key created in the app to authenticate, write a record and send a saved template. The API reference then has every operation with request examples, plus how errors, paging, retries and rate limits behave.
Send email over SMTP instead
If the system that needs to send email speaks SMTP more comfortably than HTTP, open Settings, then Developers, then the SMTP tab. It hands you the host, the port and the username to copy, and any of your API keys works as the password.
The SMTP message body is a JSON payload naming the saved template and its input data. maxclicks renders the content authored in the app. That way an SMTP send is personalized and tracked exactly like every other send.
Get told when something happens
Webhooks run the other way: maxclicks calls a URL of yours. Create them under Settings, then Developers, then the Webhooks tab. You can be called when a contact is upserted or deleted, an object is upserted or deleted, an event is fired, or an email event happens such as a bounce or a click.
If your endpoint keeps failing, maxclicks stops calling it. The webhook shows Circuit breaker active, with how many calls failed in a row and the last error it saw, and nothing is delivered until you click Reset and resume. Check the Webhooks tab after you deploy changes to a receiving endpoint.
The Webhooks reference covers the payloads and how to verify that a call really came from maxclicks.
Hand your space to an AI agent
The MCP server is the tool interface for an external AI assistant to operate supported Public API actions. Check its current availability and connection instructions before configuring a client. The REST API remains the direct integration path.
It goes through the same API with the same key, so it can do exactly what that key can do and nothing more. Note the direction: maxinja is the AI inside maxclicks that builds things for you, and the MCP server is the door your own AI reaches in through.
Not ready to install yet
Use the SDK catalog, CLI and MCP reference for current release and connection status. Until a documented package or hosted service is available, implement the supported requests directly over REST rather than treating example package names as an available installation.
Everything on this page is the same REST API underneath. Each surface uses your API key, counts against the same rate limits, and can do neither more nor less than the API itself.
Next
That is every surface of maxclicks: your data, maxinja, sending, automation, and the programmatic doors. The last stop is a quick reference for the vocabulary you picked up along the way.
maxclicks glossary