Outbound Webhooks

Push data changes made in iamGIS to other systems as they happen.

An outbound webhook is a method used to send information from iamGIS to another system when an event occurs - a feature is created, or feature data is updated. This provides an easy and timely way of sharing your data in iamGIS with other systems. It could be used to alert someone of an important change that was made (the completion of a work order perhaps) or to keep another system up to date with the work being done in iamGIS or to enable that perfect workflow that works great for your team. There are endless uses for outbound webhooks to empower your organization and make your life easier. 

How to setup outbound webhooks

From your account settings page, you will select the organization you want to set up an Outbound Webhook for. Your organization is displayed right next to the account settings title. Under Webhooks, select Outbound to create a new type of webhook. By clicking the plus button, you will see the different types, like a feature, which will allow you to configure a webhook for any feature (asset) from any map or layer within your organization. 

First, you're going to scroll down and click on Example Payload, which will display the example below. This is the data that will be sent through the webhook once it is set up appropriately. 

Under which events would you like to trigger with this webhook, you can select three options. 

• Create - will trigger only when a feature is created within iamGIS. 
• Update - any time there is an existing feature and the data within the feature is updated, specifically the data within the feature. It will not trigger if attachments or notifications are added. Only when data fields within the feature details window or within the results table.
• Delete - Will be triggered when the feature is deleted from the map. 

The URL is to specify the specific application or potentially a serverless function with the cloud that a user could send this webhook payload to. This should be configured by an engineer or developer who knows how to receive the data to the specified location.

example: https://{myapplication}/webhook. 

If this does not contain any app specific data, the user would first need to go to a specified function or API call that a developer would be able to receive this data and send it to the specific API or application you desire. 

Secret - Under the URL you will see the secret text box. By selecting Generate Secret, it will provide security for the webhook, so the sender and receiver are able to know this is a valid message. This can be parsed and used to ensure the security. For further details you can read documentation on what security algorithms are used, for when it's received and can be properly decrypted on the other side to make sure it's from a valid sender.