Add and manage webhooks

This article covers:

• Add a webhook
• Edit a webhook
• Delete a webhook

To send data to a third-party application using webhooks, you first need to add the application’s webhook URL to OnLocation and configure the settings for sending the data.

Add a webhook

• Go to: Tools > Account.
• Select Integrations from the left-hand menu.
• Select the Webhooks integration.
• Click Settings.
• Click Create a New Webhook.
  
  
  
• Enter the webhook name. This is used to identify the webhook.
• Paste in the Webhook URL. This is the unique web address of your third-party application that will receive the data.
• Select the method. This is the action to be performed on the URL:
  • POST will send information to the application.
  • GET will ping the application, instructing it to perform an action, but won’t include any information from OnLocation.
• Select the content type: Form Encoded, JSON, XML, or RAW. This determines how the information is formatted when sent and is dictated by your third-party application. We recommend the JSON format.
• (Optional) Complete the optional settings (see below).
• (Optional) Complete the trigger settings (see below).
• Click Save. 
  
  
  

Optional settings

These are additional security settings that your third-party application may require. If required, you can enter these security settings here:

• Basic Auth Username - Username required to satisfy your security settings.
• Basic Auth Password - Password required to fulfil your security settings.
• HTTP Headers - Information that will always be included in the URL that is receiving the data. This is generally used as an extra security measure by applications. Click the + button to add more.

Trigger settings

You can add static placeholders to create data sent to your webhook when using a custom data packet in your trigger settings. This allows you to use a single value across multiple triggers, which can be easily modified in these settings.

Any placeholders added here can be used in a custom data packet when this webhook is selected. Click the add button to add more.

Enter the name of the trigger placeholder without spaces, e.g. ACS_Username. When using the placeholder in your custom data packet, enter it as {{webhook.PlaceholderName}}, e.g. {{webhook.ACS_Username}}.

Enter the value that will be sent when this placeholder is used, e.g. Admin.

Edit a webhook

• Go to: Tools > Account.
• Select Integrations from the left-hand menu.
• Select the Webhooks integration.
• Click Settings.
• Click View next to a webhook.
  
  
• Update the details.
• Click Save.

Delete a webhook

• Go to: Tools > Account.
• Select Integrations from the left-hand menu.
• Select the Webhooks integration.
• Click Settings.
• Click Delete next to a webhook.
  
  
• Click Remove to confirm.