Update Integration

Prev Next
Put
/api/v1/integrations.update

Update an existing integration.

Permissions required:

  • manage-incoming-integrations
  • manage-own-incoming-integrations
  • manage-outgoing-integrations
  • manage-own-outgoing-integrations
Version Description
3.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
Body parameters
object
type
string Required

The type of integration. The possible values are:

  • webhook-outgoing
  • webhook-incoming
name
string Required

The name of the integration.

enabled
boolean Required

Whether this integration should be enabled or not.

username
string Required

The username to post this the messages as.

scriptEnabled
boolean Required

Whether the script should be enabled.

channel
string Required

The channel, group, or @username. The values can also be all_public_channels, all_private_groups, or all_direct_messages. Comma separated for more than one.

integrationId
string Required

The integration ID.

urls
Array of string

The urls to call whenever this integration is triggered.

string
event
string

This field is required only for outgoing integrations. The type of event can be any of these: sendMessage, fileUploaded, roomArchived, roomCreated, roomJoined, roomLeft, userCreated.

triggerWords
string

Specific words, separated by commas, which should trigger this integration.

alias
string

The alias which should be applied to messages when this integration is processed.

avatar
string

The logo to apply to the messages that this integration sends.

Examplehttp://res.guggy.com/logo_128.png
emoji
string

The emoji which should be displayed as the avatar for messages from this integration.

Example:ghost:
token
string

If your integration requires a special token from the server (API key), use this parameter.

script
string

Script triggered when this integration is triggered.

targetChannel
string

The channel where messages will be sent to.

target_url
string

The target url to set.

Responses
200
400
401
Collapse all
object
integration
object
_id
string
enabled
boolean
channel
Array of string
string
username
string
name
string
alias
string
avatarUrl
string
emoji
string
scriptEnabled
boolean
script
string
type
string
token
string
userId
string
_createdAt
string
_createdBy
object
_updatedAt
string
_updatedBy
object
success
boolean