Appearance

Create Integration ​

Create a new integration. Typically used to add new custom integrations or to register a new API integration in your Truto account.

Endpoint ​

http
POST /integration

Request Body ​

name
string
REQUIRED · 

The name of your integration.

Example: my_custom_crm
category
string

A short descriptor or category.

Example: crm
config
object

The core configuration object for the integration.

Example: { "base_url": "https://my-crm.example.com/api", "label": "My CRM", "credentials": { "api_key": { "format": "api_key", "config": { "fields": [ { "name": "api_key", "label": "API Key", "type": "password" } ] } } } }
is_beta
boolean

Whether the integration is considered beta.

Response Body ​

id
string · uuid

The ID of the integration.

Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7
name
string

The name of the integration.

Example: zendesk
category
string

The category of the integration.

Example: helpdesk
is_beta
boolean

Whether the integration is in beta or not. Beta integrations might not have been tested completely and are not recommended for production environments.

config
object

The configuration object defining the underlying API of the integration.

Example: { "base_url": "https://api.example.com", "label": "Example API", "logo": "https://example.com/logo.png", "headers": { "Content-Type": "application/json", "Accept": "application/json", "User-Agent": "truto" }, "authorization": { "format": "bearer", "config": { "value": "{{oauth.token.access_token}}" } }, "pagination": { "format": "page", "config": { "page_key": "page", "limit_key": "per_page" } }, "resources": { "users": { "list": { "method": "get", "path": "/users", "response_path": "data.users" } } } }
team_id
string · uuid

The ID of the team that owns this integration.

Example: 05daecaf-4365-42e8-8370-8127de5dd717
sharing
string

The sharing policy of the integration.

All possible enum values:
  • allow
  • ask
  • deny
Example: allow
created_at
string · date-time

The date and time when the integration was created.

Example: 2021-08-10T10:00:00.000Z
updated_at
string · date-time

The date and time when the integration was last updated.

Example: 2021-08-10T10:00:00.000Z
installed_environment
string[]

A list of environment IDs where this integration is installed.

team
object

The team that owns this integration.

id
string · uuid

The ID of the team.

Example: 05daecaf-4365-42e8-8370-8127de5dd717
name
string

The name of the team.

Example: My Awesome Team
domain
string

The domain of the team.

Example: example.com
logo
string

The URL of the team's logo.

Example: https://example.com/logo.png
is_verified
boolean

Whether the team is verified or not.

Example: true
is_white_label
boolean

Whether the team is white-labeled or not.

tos_link
string

A link to the team's Terms of Service, if available.

Example: https://example.com/tos
allow_impersonation
boolean

Whether the team allows impersonation.

created_at
string · date-time

The date and time when the team was created.

Example: 2021-08-10T10:00:00.000Z
updated_at
string · date-time

The date and time when the team was last updated.

Example: 2021-08-10T10:00:00.000Z