Vault keeps track of the state
for each connection towards an integration.
More info on different "states" of a connection can be found in our guide.
Using the Vault API, you can retrieve the connections a consumer has or all connections for your account or a single connection. The state
property is important if you want to know if a connection is ready to be used.
The connection state
shows the state throughout the life-cycle of the connection.
If the state
is callable
, the consumer has authorized the integration and you should be able to access the integration through the Unify API.
If the connection changes, the state
will be updated as well, when requesting all connections for your account or a specific single connection.
โ
Or you can listen to the Vault changes by subscribing to the Vault wehbook events.
Vault will broadcast webhook events for any change that occurs with the connection.