Skip to main content
This guide explains the full process to create and connect your end-users (called consumers) to a connector in Chift, and how to complete the connection activation.

​
1. Retrieve Active Integrations

This step is only needed if you want to build your own marketplace inside your product.
The endpoint lets you retrieve all active integrations (connectors) from your Chift platform, with their technical integration_id and logos.
  • If you build your own marketplace → use this endpoint.
  • If you use Chift’s hosted marketplace → you can skip this step.
Endpoint: Get list of integrations
API Reference ↗️
  • Use the query parameter status=active to get the list of available connectors.
  • Logos can also be retrieved as base64 to display in your interface:
    Endpoint: Returns a logo/icon of an integration (as base64) API Reference ↗️

​
2. Create the Consumer

A consumer represents your end-customer inside Chift. Endpoint: Create new consumer
API Reference ↗️ Fields:
  • name: Required - Consumer name.
  • redirect_url: URL to redirect the user after activation.
    • Can be customized per consumer.
    • Or set as a static default in Chift’s platform for all consumers and connectors (see this page)
    • Only effective if you specify integrationId during connection creation (see next section); otherwise, the consumer is redirected to Chift’s default Marketplace.
  • internal_reference: Your internal ID/reference for this consumer.
  • email: Used for automated reminders and local agent deployment (if relevant).
Once the consumer exists, generate an activation link so they can connect their software. Endpoint: Add new connection
API Reference ↗️ Fields:
  • name: Required - Display name of the connection.
  • integrationId: From Step 1.
    • If omitted, the consumer is redirected to the Chift marketplace to choose a connector.
  • consumerId: Required - From Step 2.
Important: The redirect will only work if integrationId is specified. If you use our Marketplace instead, the consumer will be redirected there to choose a connector.
The activation link must then be shared with the consumer.
It is secured by a token and valid for 30 minutes.

​
4. Monitor Connection Status

After sharing the activation link, you need to check if the connection was successfully established. Options:
  • Webhook: Subscribe to account.connection.created.
    Webhook Docs ↗️
    Triggered when the connection is active.
  • API Call:
    Get connections
    API Reference ↗️
    Returns all connections linked to the consumer, including their active status.     Fields: consumerId: Required - From Step 2.
  • Redirect URL parameters : If a redirect_url was set during consumer creation, additional query parameters are automatically appended by default when the user is redirected. The following parameters may be included:
    • consumerId
    • connectionId
    • connectionStatus (active / inactive)
    • error (only in case of error)
    • isExpiredError (only in case of error)
    More details on the Configure account page.

​
Update an Existing Connection

⚠️ Pro tip: Do not delete and recreate a connection if credentials expire or activation was not completed.
Instead, use the update endpoint to resend the activation link or adjust metadata (e.g. name, redirect_url). Endpoint: Update an existing connection
API Reference ↗️ Required fields:
  • consumerId: From Step 2
  • connectionId: From Step 3
⌘I