Creates an integration, if the callee has the permissions. Requires manage-incoming-integrations
AND manage-own-incoming-integrations
permissions to be able to create incoming integrations and manage-outgoing-integrations
AND manage-own-outgoing-integrations
to be able to create outgoing integrations.
URL | Requires Auth | HTTP Method |
|
|
|
Argument | Example | Required | Description |
|
| Required | The type of integration to create, |
|
| Required | The name of the integration, only is show on the Administration area. |
|
| Required | Whether this integration should be enabled or not. |
|
| Required | This field is required only for outgoing integration. The type of event, can be any of these: |
|
| Required | The username who to post this the messages as. |
|
| Required | The urls to call whenever this integration is triggered. |
|
| Required | Whether the script should be enabled. |
|
| Required | The channel, group, or |
|
| Optional Default: | Specific words, separated by commas, which should trigger this integration. |
|
| Optional Default: | The alias which should be applied to messages when this integration is processed. |
|
| Optional Default: | The logo to apply to the messages that this integration sends. |
|
| Optional Default: | The emoji which should be displayed as the avatar for messages from this integration. |
|
| Optional Default: | If your integration requires a special token from the server (api key), use this. |
| ​Integrations​ | Optional | Script triggered when this integration is triggered. |
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \-H "X-User-Id: aobEdbYhXfu5hkeqG" \-H "Content-type: application/json" \http://localhost:3000/api/v1/integrations.create \-d '{ "type": "webhook-outgoing", "name": "Testing via REST API", "event": "sendMessage", "enabled": false, "username": "rocket.cat", "urls": ["http://text2gif.guggy.com/guggify"], "scriptEnabled": false }'
{"integration": {"type": "webhook-outgoing","name": "Testing via REST API","enabled": false,"username": "rocket.cat","event": "sendMessage","urls": ["http://text2gif.guggy.com/guggify"],"scriptEnabled": false,"userId": "rocket.cat","channel": [],"_createdAt": "2017-01-06T13:23:46.018Z","_createdBy": {"username": "graywolf336","_id": "aobEdbYhXfu5hkeqG"},"_updatedAt": "2017-01-06T13:23:46.018Z","_id": "3aazpZ2WzoBP8msi9"},"success": true}
Version | Description |
1.1.0 | Separate permissions in |
0.49.0 | Added |