Overview

INSIDE Gateway installation REST API 1.0.0

The INSIDE Gateway REST API for application installations. Every request is checked against the credential’s current websites, scopes, data access flags and restrictions.

Information

• OpenAPI version: 3.1.0

Operations

GET

/api/v1/operations/{operation_id}

GET

/api/v1/websites

GET

/api/v1/capabilities

GET

/api/v1/health

GET

/api/v1/context

GET

/api/v1/guides/{guide}

GET

/api/v1/conversations

GET

/api/v1/conversations/{conversation_id}

GET

/api/v1/conversations/{conversation_id}/contacts

GET

/api/v1/conversations/{conversation_id}/messages/{message_id}

GET

/api/v1/conversations/{conversation_id}/messages

POST

/api/v1/conversations/{conversation_id}/disposition

GET

/api/v1/dashboard/visitors/{visitor_id}

GET

/api/v1/dashboard/visitors/{visitor_id}/conversations

GET

/api/v1/visitors/{visitor_id}/notes

POST

/api/v1/visitors/{visitor_id}/notes

GET

/api/v1/contacts

GET

/api/v1/contacts/{contact_id}

GET

/api/v1/contacts/{contact_id}/visitors

GET

/api/v1/contacts/{contact_id}/notes

GET

/api/v1/files/{file_id}/content

GET

/api/v1/files/{file_id}

GET

/api/v1/conversations/{conversation_id}/messages/{message_id}/attachments

GET

/api/v1/operators

GET

/api/v1/dispositions

GET

/api/v1/saved_responses

GET

/api/v1/saved_links

GET

/api/v1/offers

GET

/api/v1/channels

GET

/api/v1/teams

GET

/api/v1/analytics/ai-conversations/summary

GET

/api/v1/ai/features

GET

/api/v1/ai/features/{feature_id}

POST

/api/v1/ai/features/{feature_id}/execute

GET

/api/v1/settings/catalog

GET

/api/v1/settings/schema

GET

/api/v1/settings/item

GET

/api/v1/settings/search

POST

/api/v1/settings/plans

GET

/api/v1/subscriptions

POST

/api/v1/subscriptions

GET

/api/v1/subscriptions/{subscription_id}

DELETE

/api/v1/subscriptions/{subscription_id}

PATCH

/api/v1/subscriptions/{subscription_id}

GET

/api/v1/events

POST

/api/v1/realtime/sessions

POST

/api/v1/realtime/sessions/{session_id}/tickets

DELETE

/api/v1/realtime/sessions/{session_id}

GET

/api/v1/realtime/sessions/{session_id}/socket

Authentication

installation_token

Use the secret disclosed once when issuing an expiring credential. Never put it in a URL.

Security scheme type: http

Bearer format: igw_live_ or igw_test_ opaque installation token

oauth_client_credentials

Confidential installations exchange their credential ID and once-disclosed secret for a short-lived bearer. Parent and token authority are rechecked on every use.

Security scheme type: oauth2

Flow type: clientCredentials

Token URL: https://api.inside.chat/oauth/token

Scopes:

• website_read - website read
• health_read - health read
• conversation_read - conversation read
• contact_read - contact read
• contact_read_pii - contact read pii
• visitor_notes_read - visitor notes read
• config_read - config read
• config_plan - config plan
• ai_features_read - ai features read
• ai_execute - ai execute
• reports_read - reports read
• file_read - file read
• message_content_read - message content read
• visitor_notes_write - visitor notes write
• conversation_update - conversation update
• directory_read - directory read
• live_read - live read
• event_read - event read
• internal_notes_read - internal notes read