Integration data model

Informational object for supported integrations.

Data Model

typestring required
Identifier for this integration
created_atstring
Date that this integration was supported (YYYY-MM-DD) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring
YYYY-MM-DD (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring required
The integration's name
is_activeboolean
Is this integration active in this workspace
categories enum array required
Valid values:
"passthrough"
"hris"
"ats"
"auth"
"crm"
The categories of support solutions that this integration has
api_docs_urlstring
The URL of the integration's API documentation
logo_urlstring
The URL of the integration's logo
in_progressboolean
If this integration is not yet available as it is currently being built by unified.to
is_hiddenboolean
colorstring
button background color for AUTH
text_colorstring
text color for AUTH
fa_iconstring
font-awesome icon
token_namesstring array
if auth_types = 'token'
token_instructionsstring array
instructions for the user on how to find the token/key
web_urlstring
URL for the software vendor
rate_limit_descriptionstring
betaboolean
This integration is new and is still considered "beta"
supportstring dictionary
tested_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sandboxany
partnershipany
samlany
descriptionstring
apiany
featuredboolean
popularitynumber
active_healthy_connectionsnumber
Are we missing anything? Let us know
Was this page helpful?