It is intended for developers managing consumer connections in Chift.
Monitor Connection Status
Once the activation link has been shared, you need to verify whether the connection was successfully established. There are the options:1. Webhook
Subscribe to theaccount.connection.created event.Triggered automatically when the connection becomes active.
⚠️ Important:Webhook Docs ↗️
Theaccount.connection.createdwebhook is only triggered when the connection has been successfully created.
If the consumer never completes the activation, no webhook event will be sent.
We therefore recommend combining this with another logic — for example, a timeout or periodic check — to handle incomplete activations.
2. API Call
Retrieve all connections linked to a consumer and check theiractive status.
Endpoint: Get connectionsAPI Reference ↗️ Required field:
consumerId— From the consumer creation step
3. Redirect URL Parameters
If aredirect_url was set when creating the consumer, Chift automatically appends query parameters when the user is redirected after activation.
Returned parameters:
consumerIdconnectionIdconnectionStatus(active/inactive)error(only in case of error)isExpiredError(only in case of error)
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 connectionAPI Reference ↗️ Required fields:
consumerId— From consumer creationconnectionId— From connection creation
Updating a connection allows you to maintain active links without forcing the user to reconnect from scratch.
This preserves historical data and ensures smoother API usage.