Remove Integration

Print
Dark
Light
PDF

Remove Integration

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/api/v1/integrations.remove

Remove an integration from the workspace.

Permissions required:

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

Changelog

Version	Description
1.1.0	Separate permissions in incoming and outgoing.
0.49.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

Body parameters

Example 1

{
  "integrationId": "oNLthAt9RwMw39N2B",
  "type": "webhook-outgoing"
}

object

integrationId

string Required

The integration ID to remove.

type

string Required

The type of integration. The possible values are:

webhook-outgoing
webhook-incoming

Responses

200

Incoming integration example

{
  "integration": {
    "type": "webhook-incoming",
    "username": "rocket.cat",
    "channel": false,
    "scriptEnabled": "sendMessage",
    "name": "sendMessage",
    "enabled": "sendMessage"
  }
}

Outgoing integration example

{
  "integration": {
    "_id": "oNLthAt9RwMw39N2B",
    "type": "webhook-outgoing",
    "name": "Testing via REST API",
    "enabled": "false",
    "username": "rocket.cat",
    "urls": [
      "http://text2gif.guggy.com/guggify"
    ],
    "scriptEnabled": "false",
    "userId": "rocket.cat",
    "channel": [],
    "_createdAt": "2017-01-06T01:42:14Z",
    "_createdBy": {
      "username": "graywolf336",
      "_id": "R4jgcQaQhvvK6K3iY"
    },
    "_updatedAt": "2017-01-06T01:42:14Z"
  },
  "success": true
}

Expand All

object

integration

object

type

string

username

string

channel

boolean

scriptEnabled

string

name

string

enabled

string

400

Bad Request

Example 1

{
  "success": false,
  "error": "must have required property 'type'\n must have required property 'type'\n must have required property 'type'\n must match exactly one schema in oneOf [invalid-params]",
  "errorType": "invalid-params"
}

Example 2

{
  "success": false,
  "error": "must have required property 'integrationId'\n must have required property 'target_url'\n must have required property 'integrationId'\n must match exactly one schema in oneOf [invalid-params]",
  "errorType": "invalid-params"
}

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

Was this article helpful?

What's Next

Get WebDAV Accounts