Update an Integration
To update an integration, the callee needs to have the permissions manage-incoming-integrations
AND manage-own-incoming-integrations
permissions to be able to update incoming integrations and manage-outgoing-integrations
AND manage-own-outgoing-integrations
to be able to update outgoing integrations.
HTTP Method | URL | Requires Auth |
---|---|---|
|
|
Body Parameters
Key | Example Value | Description |
---|---|---|
|
| The type of integration to update, |
|
| The name of the integration only is shown in the Administration area. |
|
| Whether this integration should be enabled or not. |
|
| The username who to post this the messages as. |
|
| The channel, group, or |
|
| Whether the script should be enabled. |
|
| The integration ID that you want to update. |
|
| The urls to call whenever this integration is triggered. |
|
| This field is required only for outgoing integration. The type of event can be any of these: |
|
| Specific words, separated by commas, which should trigger this integration. |
|
| The alias which should be applied to messages when this integration is processed. |
|
| The logo to apply to the messages that this integration sends. |
|
| The emoji which should be displayed as the avatar for messages from this integration. |
|
| If your integration requires a special token from the server (api key), use this. |
| Integrations | Script triggered when this integration is triggered. |
|
| The channel where messages will be sent to. |
|
| The target url to set. |
Example Payload
Example Call
Example Response
Success
Error
Any of the following errors can occur on the endpoint.
Authorization: Requires an authentication token for the request to be made.
Missing Key: Triggers when the endpoint is called without any required endpoint.
No integration Found: You get this error when the integration you're trying to update is not found.
Change Log
Version | Description |
---|---|
3.4.0 | Added |
Last updated