Retriever Integration

GET 
/api/v2/instance/:instanceId/chatwoot-integration

Retriever Integration

Request

Path Parameters

instanceId stringrequired

ID of the instance.

Responses

200

Success - status: 200

application/json

Schema

Schema

integrationId stringrequired
enabled booleanrequired
accountId numberrequired
inboxId numberrequired
chatwootURL stringrequired
chatwootAccessToken stringrequired
enabledGroup booleanrequired
displayAttendant booleanrequired
startConversationAs stringrequired

Possible values: [pending, open]

createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired
instanceInstanceId stringrequired
Webhook object
url Urlrequired
Instance unique url.
enabled Enabled
Default value: false
Enable or disable the url.
webhookId stringrequired

Example (from schema)

{
  "integrationId": "string",
  "enabled": true,
  "accountId": 0,
  "inboxId": 0,
  "chatwootURL": "string",
  "chatwootAccessToken": "string",
  "enabledGroup": true,
  "displayAttendant": true,
  "startConversationAs": "pending",
  "createdAt": "2024-04-14T14:11:05.732Z",
  "updatedAt": "2024-04-14T14:11:05.732Z",
  "deletedAt": "2024-04-14T14:11:05.732Z",
  "instanceInstanceId": "string",
  "Webhook": {
    "url": "string",
    "enabled": false,
    "webhookId": "string"
  }
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

403

ForbiddenException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

404

NotFoundException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...