Makini
v4 (Latest)
  • v4 (Latest)
  • v3 (Legacy)
User Guide
API Reference
User Guide
API Reference
Website
v4 (Latest)
  • v4 (Latest)
  • v3 (Legacy)
v4 (Latest)
  • v4 (Latest)
  • v3 (Legacy)
  1. Core Concepts
  • Getting Started
    • Connection Credits
    • IP Whitelisting
    • Authentication
    • Testing with API Tools
    • Account setup
  • Core Concepts
    • Connections
    • Unified Data Model
  • Admin API
    • Authentication
  1. Core Concepts

Connections

A connection represents a link between your Makini account and a specific third-party system (e.g., an SAP instance, an Odoo account, or an UpKeep workspace). Each connection is a separate data channel — it has its own token, sync state, and credit cost.
Connections can be created through Makini Link, Magic Links, or the Admin API.

Connection Properties#

PropertyDescription
Connection IDTechnical identifier used in the Admin API.
Connection nameThe name entered by you or your customer during the Makini Link flow.
EmailThe email entered during the Makini Link flow.
CreditsNumber of credits consumed by this connection. See Connection Credits.
SystemThe connected platform/adapter.
StatusCurrent state of the connection. See below.
Connected atTimestamp of when the connection was established.
Last syncTimestamp of the most recent data sync.

Connection Statuses#

Pending — A Magic Link was created with a predefined connection name, metadata, etc., but the user has not completed the connection flow yet.
Synchronizing — Connection data is being initialized or updated from the connected system.
In progress — Data is being processed.
Active — The connection is fully operational and ready for API requests.
Inactive — The connection has been disabled due to insufficient credits. On paid accounts, it can be reactivated as Overage.

Metadata#

Connections support custom key-value metadata. This allows you to store additional information alongside a connection, such as a customer ID in your own system or platform-specific configuration parameters.
Metadata can be set when creating or editing a connection in the dashboard. It is accessible via the connection status API as the user_metadata field.

Magic Links#

A Magic Link is a pre-configured Makini Link URL that includes a predefined connection name, metadata, and other parameters. This allows you to generate a unique onboarding link for each of your customers, so that when they complete the flow, the connection is automatically associated with the right context.
To create a Magic Link:
1.
Navigate to Connections in the dashboard.
2.
Click Create new.
3.
Enter the connection details (name, metadata, etc.).
The generated link can be shared with your customer. Until they complete the authentication flow, the connection appears in your dashboard with a Pending status.

Checking Connection Status via API#

You can check the status of a connection programmatically:
This returns the current connection's properties including its status, system, and last sync timestamp.
Modified at 2026-02-15 16:35:52
Previous
Account setup
Next
Unified Data Model
Built with