Appearance

Get integration specific documentation for a unified model ​

For certain integrations, your customers might need assistance in connecting them to Truto, especially for API Key based integrations where they need to provide their API Key to Truto. In other cases, the features provided by the unified API for the integration might be available only on certain pricing plans, or the user connecting the integration might need to have certain user permissions or roles.

To help your customers with this, you can use this endpoint to get integration specific documentation for a unified model like,

  • Pricing plan considerations
  • User roles who can connect the integration
  • Scopes required (for OAuth integrations)
  • Integration specific instructions

This information can be displayed to your customers when they are connecting the integration to Truto.

Truto provides this information in 3 formats,

  • JSON
  • Markdown
  • HTML (Sanitized)

Endpoint ​

http
GET /unified/meta/{model_name}/{integration_name}

Path parameters ​

model_name
string
REQUIRED · 

The name of the unified model to get the documentation for.

Example: user-directory
integration_name
string
REQUIRED · 

The name of the integration to get the documentation for.

Example: freshdesk

Query parameters ​

Refer Specifying query parameters in Truto APIs

format
string

The format in which to return the documentation. Default is json.

All possible enum values:
  • json
  • md
  • html

Response Body ​

pricing_plan
string[]

The list of pricing plans for which the integration is available. In free text format, ready to be displayed as it is.

user_role
string[]

The list of user roles who can connect the integration. In free text format, ready to be displayed as it is.

scopes
string[]

The list of scopes required to make the unified API work.

instructions
string · markdown

The integration specific instructions like steps to create an API key, getting account subdomain, etc. In Markdown format.