Sessions
The Sessions model
Custom consumer settings that are passed as part of the session.
Create Session
Making a POST request to this endpoint will initiate a Hosted Vault session. Redirect the consumer to the returned url to allow temporary access to manage their integrations and settings.
Note: This is a short lived token that will expire after 1 hour (TTL: 3600).
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Additional redirect uri and/or consumer metadata
Request body schema
application/jsonCustom consumer settings that are passed as part of the session.
Responses
Request example
Response example
Connections
The Connections model
Get all connections
This endpoint includes all the configured integrations and contains the required assets to build an integrations page where your users can install integrations. OAuth2 supported integrations will contain authorize and revoke links to handle the authentication flows.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Query parameters
Scope results to Unified API
Scopes results to connections that have been configured or not
Responses
Request example
Response example
Get connection
Get a connection
Path parameters
Service ID of the resource to return
Unified API
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Responses
Request example
Response example
Create connection
Create an authorized connection
Path parameters
Service ID of the resource to return
Unified API
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Fields that need to be persisted on the resource
Request body schema
application/jsonWhether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.
Connection settings. Values will persist to form_fields
with corresponding id
Attach your own consumer specific metadata
Responses
Request example
Response example
Update connection
Update a connection
Path parameters
Service ID of the resource to return
Unified API
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Fields that need to be updated on the resource
Request body schema
application/jsonWhether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.
Connection settings. Values will persist to form_fields
with corresponding id
Attach your own consumer specific metadata
Responses
Request example
Response example
Deletes a connection
Deletes a connection
Path parameters
Service ID of the resource to return
Unified API
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Responses
Request example
Response example
Import connection
Import an authorized connection.
Path parameters
Service ID of the resource to return
Unified API
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Fields that need to be persisted on the resource
Request body schema
application/jsonConnection settings. Values will persist to form_fields
with corresponding id
Attach your own consumer specific metadata
Responses
Request example
Response example
Get Access Token
Get an access token for a connection and store it in Vault. Currently only supported for connections with the client_credentials OAuth grant type.
Note that the access token will not be returned in the response. A 200 response code indicates a valid access token was stored on the connection.
Path parameters
Service ID of the resource to return
Unified API
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Request body schema
application/jsonResponses
Request example
Response example
Get resource settings
This endpoint returns custom settings and their defaults required by connection for a given resource.
Path parameters
Unified API
Service ID of the resource to return
Resource Name
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Responses
Request example
Response example
Update settings
Update default values for a connection's resource settings
Path parameters
Service ID of the resource to return
Unified API
Resource Name
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Fields that need to be updated on the resource
Request body schema
application/jsonWhether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.
Connection settings. Values will persist to form_fields
with corresponding id
Attach your own consumer specific metadata
Responses
Request example
Response example
Authorize
In most cases the authorize link is provided in the /connections
endpoint. Normally you don't need to manually generate these links.
Use this endpoint to authenticate a user with a connector. It will return a 301 redirect to the downstream connector endpoints.
Auth links will have a state parameter included to verify the validity of the request. This is the url your users will use to activate OAuth supported integration providers.
Vault handles the complete Authorization Code Grant Type Flow for you and will redirect you to the dynamic redirect uri you have appended to the url in case this is missing the default redirect uri you have configured for your Unify application.
Path parameters
Service ID of the resource to return
Application ID of the resource to return
Query parameters
An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks.
URL to redirect back to after authorization. When left empty the default configured redirect uri will be used.
One or more OAuth scopes to request from the connector. OAuth scopes control the set of resources and operations that are allowed after authorization. Refer to the connector's documentation for the available scopes.
Responses
Request example
Response example
Revoke
In most cases the authorize link is provided in the /connections
endpoint. Normally you don't need to manually generate these links.
Use this endpoint to revoke an existing OAuth connector.
Auth links will have a state parameter included to verify the validity of the request. This is the url your users will use to activate OAuth supported integration providers.
Vault handles the complete revoke flow for you and will redirect you to the dynamic redirect uri you have appended to the url in case this is missing the default redirect uri you have configured for your Unify application.
Path parameters
Service ID of the resource to return
Application ID of the resource to return
Query parameters
An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks.
URL to redirect back to after authorization. When left empty the default configured redirect uri will be used.
Responses
Request example
Response example
Callback
This endpoint gets called after the triggering the authorize flow.
Callback links need a state and code parameter to verify the validity of the request.
Query parameters
An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks.
An authorization code from the connector which Apideck Vault will later exchange for an access token.
Responses
Request example
Response example
Consumers
The Consumers model
Get all consumers
This endpoint includes all application consumers, along with an aggregated count of requests made.
Header parameters
The ID of your Unify application
Query parameters
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of records to return
Responses
Request example
Response example
Get consumer
Consumer detail including their aggregated counts with the connections they have authorized.
Path parameters
ID of the consumer to return
Header parameters
The ID of your Unify application
Responses
Request example
Response example
Consumer request counts
Get consumer request counts within a given datetime range.
Path parameters
ID of the consumer to return
Header parameters
The ID of your Unify application
Query parameters
Scopes results to requests that happened after datetime
Scopes results to requests that happened before datetime
Responses
Request example
Response example
Logs
The Logs model
Indicates if the request was made via REST or Graphql endpoint.
The Apideck base URL the request was made to.
Indicates whether or not this is a child or parent request.
The consumer Id associated with the request.
The entire execution time in milliseconds it took to call the Apideck service provider.
If error occurred, this is brief explanation
Get all consumer request logs
This endpoint includes all consumer request logs.
Header parameters
The ID of your Unify application
ID of the consumer which you want to get or push data from
Query parameters
Filter results
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of records to return
Responses
Request example
Response example
Connection UpdatedWebhook
Connection Updated
Header parameters
The type of event that was triggered
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Request example
Connection CreatedWebhook
Connection Created
Header parameters
The type of event that was triggered
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Request example
Connection DeletedWebhook
Connection Deleted
Header parameters
The type of event that was triggered
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Request example
Connection CallableWebhook
Connection Callable
Header parameters
The type of event that was triggered
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Request example
Token Refresh FailedWebhook
Attempt to refresh the connections access_token failed.
Header parameters
The type of event that was triggered
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Request example