Add and manage webhooks

Learn how to add, edit or delete a webhook URL in the Webhooks integration. You need the Account Owner or IT Support user role to access these settings.

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

Add a webhook

  1. Go to Tools > Account.
  2. Select Integrations from the left-hand menu.
  3. Select the Webhooks integration.
  4. Click Settings.
  5. Click Create a New Webhook.

    Webhooks-create-new.png
  6. Enter the webhook name. This is used to identify the webhook.
  7. Paste in the Webhook URL. This is the unique web address of your third-party application that will receive the data.
  8. 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 telling it to do something but won’t include any information from OnLocation.
  9. 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.
  10. (Optional) Complete the optional settings (see below).
  11. (Optional) Complete the trigger settings (see below).
  12. Click Save. 

    Webhooks-new-details.png

Optional settings

These are additional security settings which may be required by your third-party application. 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 satisfy your security settings.
  • HTTP Headers – Information which 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

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 one value across many triggers which is 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

  1. Go to Tools > Account.
  2. Select Integrations from the left-hand menu.
  3. Select the Webhooks integration.
  4. Click Settings.
  5. Click View next to a webhook.

    Webhook-view.png
  6. Update the details. 
  7. Click Save. 

Delete a webhook

  1. Go to Tools > Account.
  2. Select Integrations from the left-hand menu.
  3. Select the Webhooks integration.
  4. Click Settings.
  5. Click Delete next to a webhook.

    Webhook-delete.png
  6. Click Remove to confirm.