KOkombo
General

Create reconnection link

Changed on

Create a link that will allow the user to reconnect an integration. This is useful if you want to allow your users to update the credentials if the old ones for example expired.

Embed this the same way you would embed the connect link. By default, the link will be valid for 1 hour.

Example Request Body

{
  "language": "en",
  "scope_config_id": "9Pv6aCFwNDEzPNmwjSsY9SQx",
  "link_type": "EMBEDDED"
}
post/integrations/{integration_id}/relink

Request

Path parameters

integration_idstring required

POST /integrations/:integration_id/relink Parameter

Request body

language'en' | 'de' | 'fr' | 'it' | 'es' nullable

Language of the connection flow UI.

scope_config_idstring nullable

Specify a scope config which the integration will start using once the reconnection flow has been completed.

This can be useful if you want to update the permissions of an integration, but only want the change to take effect once the user has updated their API credentials to prevent sync issues.

link_type'EMBEDDED' | 'MAGIC_LINK'

The type of link you want to create. EMBEDDED is for the embedded flow using the Kombo Connect SDK (these links are valid for 1 hour) and MAGIC_LINK is for magic links which you send out manually to customers (there are valid for 1 year).

This defaults to EMBEDDED, which is our recommended method of implementing the connection flow for a seamless user experience.

Response

POST /integrations/:integration_id/relink Positive response

status'success' required

Changes

  • d0e06abf1118Revision changes
    • breaking

      the request's body type changed from no type to object

    • breaking

      the / response's property format changed from url to uri for status

    • warning

      removed subschema #1 from the request body allOf list

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      the response property const value success was added for the status

    • info

      removed the success enum value from the response property for the response status