Skip to main content
Use this page when the end-user does not open the link right away, for example when you reach the end-user by email. For an interactive flow, use the activation link instead. The three links differ in lifetime and in who sends the email. Only the reminder email and the access link suit a non-interactive flow.
Bar chart of link lifetimes. Activation link: 30 minutes, not for email. Reminder email: 3 days, Chift sends the email. Access link: 3 days by default and 7 days at most, you send the email.

Lifetime of the three links. The 30-minute bar is not to scale.

A reminder email gives the end-user a new link after an interactive flow did not finish. Chift sends it. See Reminders. If you must send the email yourself, use an access link.

Sending via email

Use an access link when you must send the email from your own system. Call POST /consumers/{consumer_id}/access-links to create a longer-lived link, then send it yourself.
Flow between three parties. Your backend calls POST access-links on Chift. Chift returns id, url and expires_at to your backend. Your backend sends the url to the end-user by email. The end-user opens the url. Below, a timeline from creation to expires_at. Each visit opens a 30-minute session. At expires_at the link stops. A DELETE call revokes the link earlier.

How an access link works, from creation to expiry.

  • Pass syncid to open a sync of the consumer, or integrationid to open the connection page of one connector. You cannot pass both.
  • Use expires_at to set the expiry. The default is 3 days from now. The maximum is 7 days from now.
  • The response contains id, url and expires_at.
  • Each visit to the url opens a new 30-minute session. The link works until expires_at.
  • Call DELETE /consumers/{consumer_id}/access-links/{access_id} to expire the link immediately.
Anyone who has the link can open the consumer page until the link expires. Keep the expiry short and revoke the link when you no longer need it.