Comment on page

Remove an Integration from Server

Removes an integration from the server. Requires manage-incoming-integrations or manage-own-incoming-integrations permissions to be able to remove incoming integrations and manage-outgoing-integrations or manage-own-outgoing-integrations to be able to remove outgoing integrations.
URL
Requires Auth
HTTP Method
/api/v1/integrations.remove
yes
POST
Incoming Webhook
Payload
Argument
Example
Required
Description
integrationId
oNLthAt9RwMw39N2B
Required
The id of the integration to remove.
Example Call
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/integrations.remove \
     -d '{"integrationId": "oNLthAt9RwMw39N2B" }'
Example Result
{
    "integration": {
        "type": "webhook-incoming",
        "username": "rocket.cat",
        "channel": false,
        "scriptEnabled": "sendMessage",
        "name": "sendMessage",
        "enabled": "sendMessage",
        }
Outgoing Webhook
Payload
Argument
Example
Required
Description
type
webhook-outgoing
Required
The type of integration to remove, webhook-outgoing and webhook-incoming are supported.
integrationId
oNLthAt9RwMw39N2B
Required
The id of the integration to remove.
Example Call
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/integrations.remove \
     -d '{ "type": "webhook-outgoing", "integrationId": "oNLthAt9RwMw39N2B" }'
Example Result
{
    "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-06T13:42:14.143Z",
        "_createdBy": {
            "username": "graywolf336",
            "_id": "R4jgcQaQhvvK6K3iY"
        },
        "_updatedAt": "2017-01-06T13:42:14.144Z"
    },
    "success": true
}
Change Log
Version
Description
1.1.0
Separate permissions in incoming and outgoing.
0.49.0
Added

URL	Requires Auth	HTTP Method
`/api/v1/integrations.remove`	`yes`	`POST`

Argument	Example	Required	Description
`integrationId`	`oNLthAt9RwMw39N2B`	Required	The id of the integration to remove.

Argument	Example	Required	Description
`type`	`webhook-outgoing`	Required	The type of integration to remove, `webhook-outgoing` and `webhook-incoming` are supported.
`integrationId`	`oNLthAt9RwMw39N2B`	Required	The id of the integration to remove.

Version	Description
1.1.0	Separate permissions in `incoming` and `outgoing`.
0.49.0	Added

Last modified 1yr ago