Skip to main content
This page describes the sync activation link returned when you create the link. It also describes where Chift sends your end-user afterwards. Create the sync activation link with a POST. The response contains one field, url. The link opens a Chift-hosted page where your end-user connects their software for one sync. Key properties:
  • A token secures the link. The token expires 30 minutes after you create it.
  • The link activates one sync for one consumer.
  • You can email the link. Create it just before your end-user opens it. If the token expires, call the endpoint again to create a new link.

​
Pre-selecting connectors

A sync connects two Chift APIs. By default, your end-user chooses the connector for their software on the Chift-hosted page. To pre-select it, use the request body:
Chift validates integrationids against the sync. Two ids for the same Unified API return HTTP 400. An id that is not part of the sync returns HTTP 400.

​
Passing your own metadata

Pass a free-form link_metadata object when you create the link. Chift stores it on the consumer’s sync. Chift returns it in the sync status as link_metadata. Use it to pass your own reference, such as an internal id.

​
Where Chift sends your end-user

After your end-user completes the setup, Chift sends them to the consumer’s redirect_url. Set redirect_url per consumer when you create or update the consumer. Or set one default per environment for the account. See Default redirection URL. When you set both, Chift uses the consumer-level value. If you set no redirection URL, your end-user stays on the Chift-hosted page.
The sync request body has no redirect toggle, unlike the connection flow. Chift redirects your end-user only when you set a redirection URL.

​
Parameters on return

On redirect, Chift can add the consumer id to the redirection URL as a query parameter:
Enable this for your account first. See Redirect URL parameters. Until you enable it, your callback receives the redirection URL with no parameters.
The sync flow adds only consumerId. It does not add connectionId or connectionStatus. Those parameters belong to the connection flow.

​
Confirming completion

Do not use the redirect as a completion signal. An end-user who abandons the flow never returns. A browser can also close during the redirect. Confirm the setup with the sync status endpoint instead. Then monitor the runs. See Monitor sync executions.