Update Existing Connections

AnchorOverview

Due to changes in auth credentials, or changes from the provider, some connections will be left in a broken state where the user has to repair the connection.

The steps for repairing/updating a connection are very similar to the steps for creating a new connection. The only difference is that the connector initialize mutation will receive specific inputs that will configure the connection widget to open in update mode. Here are the steps for updating a connection:

1. Call the connector[IntegrationName]Initialize mutation to initialize a connection widget for the integration (use arguments for update mode).
2. Open the connection with the data provided by the connector[IntegrationName]Initialize mutation.
3. Check connector status from record.connectorStatus from the connector[IntegrationName]Initialize mutation.
   • If the status is CONTINUE, then the connection has been successfully repaired. No user action is required.
   • If the status is ACTION_REQUIRED, open the connection widget and the user will reconnect their account to update the connection.

Each integration typically requires a specific set of fields to update a connection. See the sections for corresponding integration’s documentation:

Note: More connection integrations will become available in the future. If you are interested in integration that’s not generally available, please contact us here.

AnchorPlaid

For a complete guide to reconnecting broken connections on the client side with React and Apollo GraphQL, check our guide on How to Reconnect Broken Plaid Connections.

AnchorInitialize Plaid Link

The connectorPlaidInitialize mutation is used to create a Link Token to configure an instance of Link. The linkToken generated by this mutation will be used for Plaid Link initialization. Check out our guides on configuring Plaid Link with React or see Plaid’s Docs for more information.

Copy to clipboard
mutation ConnectorPlaidInitialize($input: ConnectorPlaidInitializeInput) {
  connectorPlaidInitialize(input: $input) {
    success
    record {
      connectorStatus
      connectorToken
      expiration
      linkToken
      requestId
    }
    errors {
      code
      message
    }
  }
}

AnchorConnectorPlaidInitializeInput

Autogenerated input type of ConnectorPlaidInitialize

View static documentation on the GraphQL Explorer on your Dashboard for a complete list of typings.

AnchorConnectorPlaidInitializePayload

Autogenerated return type of ConnectorPlaidInitialize

View static documentation on the GraphQL Explorer on your Dashboard for a complete list of typings.

AnchorUpdate Connection

After your user successfully completes the Plaid Link session, call the connectorPlaidClose mutation from Plaid Link’s onSuccess callback, passing in the Quiltt connectorToken, along with Plaid Link’s metadata and publicToken.

Copy to clipboard
mutation ConnectorPlaidClose($input: ConnectorPlaidCloseInput) {
  connectorPlaidClose(input: $input) {
    success
    record {
      id
      accounts {
        id
        name
      }
      institution {
        name
        logo
      }
    }
    errors {
      code
      message
    }
  }
}

AnchorConnectorPlaidCloseInput

Autogenerated input type of connectorPlaidClose

View static documentation on the GraphQL Explorer on your Dashboard for a complete list of typings.

AnchorConnectorPlaidClosePayload

Autogenerated return type of connectorPlaidClose

View static documentation on the GraphQL Explorer on your Dashboard for a complete list of typings.

AnchorUpdating Connection Metadata

Quiltt adds a metadata field to the Connection type. This field is a JSON object that can be used to store any data you want. A good use of the metadata field is to store additional data about the connection that wasn’t provided by the integration provider.

Copy to clipboard
mutation ConnectionUpdate($input: ConnectionUpdateInput!) {
  connectionUpdate(input: $input) {
    errors {
      message
    }
    record {
      id
      metadata
    }
    success
  }
}

AnchorConnectionUpdateInput

Autogenerated input type of ConnectionUpdate

View static documentation on the GraphQL Explorer on your Dashboard for a complete list of typings.

AnchorConnectionUpdatePayload

Autogenerated return type of ConnectionUpdate

View static documentation on the GraphQL Explorer on your Dashboard for a complete list of typings.