docs: Add documentation for integration APIs (#2300)

This commit is contained in:
Sojan Jose
2021-05-20 20:46:45 +05:30
committed by GitHub
parent c681e8a01b
commit 46356d0bf9
23 changed files with 421 additions and 22 deletions

View File

@@ -0,0 +1,23 @@
type: object
properties:
id:
type: string
description: The ID of the integration
name:
type: string
description: The name of the integration
description:
type: string
description: The description about the team
hook_type:
type: string
description: Whether the integration is an account or inbox integration
enabled:
type: boolean
description: Whether the integration is enabled for the account
allow_multiple_hooks:
type: boolean
description: Whether multiple hooks can be created for the integration
hooks:
type: array
description: If there are any hooks created for this integration

View File

@@ -0,0 +1,23 @@
type: object
properties:
id:
type: string
description: The ID of the integration hook
app_id:
type: string
description: The ID of the integration app
inbox_id:
type: string
description: Inbox ID if its an Inbox integration
account_id:
type: string
description: Account ID of the integration
status:
type: boolean
description: Whether the integration hook is enabled for the account
hook_type:
type: boolean
description: Whether its an account or inbox integration hook
settings:
type: object
description: The associated settings for the integration

View File

@@ -2,7 +2,7 @@ type: object
properties:
id:
type: number
description: The id of the team
description: The ID of the team
name:
type: string
description: The name of the team
@@ -14,7 +14,7 @@ properties:
description: If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team
account_id:
type: number
description: The id of the account with the team is a part of
description: The ID of the account with the team is a part of
is_member:
type: boolean
description: This field shows whether the current user is a part of the team