Managing Web Hooks

What is a Web Hook?

Accordng to Wikipedia, a web hook is:

a method of augmenting or altering the behaviour of a web page, or web application, with custom callbacks. These callbacks may be maintained, modified, and managed by third-party users and developers who may not necessarily be affiliated with the originating website or application.

Essentially, what this means is that, when something happens in GAP (such as a new user being created or a new message being processed), GAP can send data about this event over the web to a third-party system.

Web Hooks are configured on a per-tenant or per-device basis.

To set up web hooks for a tenant:

1. Click "Options"
2. Click "Tenants"
3. Click "Configure Web Hooks"
4. Click "+ Add Web Hook"
5. Enter the URL to which data will be posted
6. Select what will trigger the web hook from the "Data Types" list of checkboxes
7. Select the type of authenticaton required by the URL you entered using the "Authentication Type" drop-down list. Please note this applies to all URLs.
8. Click "OK"

To delete a web hook:

1. Click "Options"
2. Click "Tenants"
3. Click "Configure Web Hooks"
4. Click "+ Add Web Hook"
5. Click "Delete Web Hook" underneath the web hook you wish to delete
6. Click "OK"

To set up web hooks for a device:

1. Click "Devices"
2. Click the device in question
3. Click "Configure"
4. Click "Configure Web Hooks"
5. Click "+ Add Web Hook"
6. Enter the URL to which data will be posted
7. Select what will trigger the web hook from the "Data Types" list of checkboxes
8. Select the type of authenticaton required by the URL you entered using the "Authentication Type" drop-down list. Please note this applies to all URLs.
9. Click "OK"

To delete a web hook:

1. Click "Devices"
2. Click the device in question
3. Click "Configure"
4. Click "Configure Web Hooks"
5. Click "+ Add Web Hook"
6. Click "Delete Web Hook" underneath the web hook you wish to delete
7. Click "OK"