Get Integration

Prev Next
Get
/api/v1/integrations.get

Get the information of a specific integration.

Permissions required:

  • manage-incoming-integrations
  • manage-own-incoming-integrations
  • manage-outgoing-integrations
  • manage-own-outgoing-integrations

Changelog

Version Description
2.4.0 Added
Header parameters
X-Auth-Token
stringRequired

The authorization token of the user.

Example9HqLlyZOugD_0YdwAJF8V47U3QHXSq
X-User-Id
stringRequired

The user ID of the user.

ExampleaobEdbYhXfu5hkeqG
Query parameters
integrationId
stringRequired

The integration ID.

ExampleByehQjC44FwMeiLbX
createdBy
string

The user ID who created the integration.

Examplefn5u45ui34fvb
Responses
200
Success Example
{
  "integration": {
    "_id": "659ea5e42dd9f928ada3e451",
    "type": "webhook-outgoing",
    "username": "test.cat",
    "channel": [
      "#general"
    ],
    "scriptEnabled": true,
    "name": "test.cat",
    "enabled": true,
    "event": "sendMessage",
    "urls": [
      "https://text2gif.guggy.com/guggify"
    ],
    "scriptEngine": "isolated-vm",
    "userId": "CkCPNcvsvCDfmWLqC",
    "_createdAt": "2024-01-10T14:12:52.201Z",
    "_createdBy": {
      "_id": "CkCPNcvsvCDfmWLqC",
      "username": "test.cat"
    },
    "_updatedAt": "2024-01-10T14:12:52.203Z"
  },
  "success": true
}
Expand All
object
integration
object
_id
string
type
string
username
string
channel
Array of string
string
scriptEnabled
boolean
name
string
enabled
boolean
event
string
urls
Array of string
string
scriptEngine
string
userId
string
_createdAt
string
_createdBy
object
_id
string
username
string
_updatedAt
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'integrationId' [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "The integration does not exists."
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string