Vault connection

A connection is a link between a consumer (end-user, client, ...) and a integration (like Salesforce, Hubspot, Bamboo HR, Workday,...). It is the result of a consumer authorizing a integration to access their data.

Vault Connection state

Using the Vault API, you can retrieve the connections a consumer has or all connections for your account or a single connection. This

state

property is important if you want to know if a connection is ready to be used.

The various

state

values, indicates the state of a connection for consumer, during the different stages. The connection state is computed based on the connection flow below.

Property state - available

The state "available" is used for available integration(s) that are not yet added/enabled by the consumer.

Property state - added

The state "added" is used for available integration(s) that are added/enabled by the consumer.

The integration is not yet authorised for OAuth.

In case of non-OAuth integrations, the credentials are not yet entered.

Property state - invalid

The state "invalid" is used for integrations where the entered credentials are invalid.

Property state - authorized

The state "authorized" is only applicable for OAuth integrations, that requires additional configuration after authorization.

Example: Xero uses OAuth, but for Apideck to connect, the consumer needs to select the desired tenant after authorization.

Property state - callable

The integration is successfully connected ✅.

For OAuth integrations, this means that requested scopes are granted and the consumer has authorised the access to his instance.

For non-OAuth integrations, this means that the entered credentials & configuration are valid. The validation happens by triggering an API request to specific endpoint towards the integrations API.

Property enabled

A connection can be enabled or disabled by the consumer. This is useful if you want to give the consumer the ability to disable a connection.

When a connection is disabled, it will not be used for API calls.

If you don't want to give the consumer the ability to disable a connection, you can disable the availability option when initialising the Vault session using the

allow_actions

setting. The

allow_actions

setting allows you to define which actions (disable, delete, ...) are available for the consumer.

Property status

This property on a connection refers to the status of the integration within the Apideck platform. More details can be found in the Connector Statuses guide.