Registering for and Using Webhooks

Webhook Basics

To jumpstart your development process we recommend using a webhook tool like request bin to quickly verify data returned by the webhook.

Webhooks will POST to the given url with the model of the object that triggered the event. For example, setting a webhook to trigger whenever a customer is modified will result in the customer object being sent.

If the webhook request does not receive a 2xx response LOCATE will attempt to fire the webhook again at 5 minute intervals for a total of 3 attempts.

Webhook Log

Webhooks that are triggered from LOCATE get logged in a webhook log ( Located under Setup > Webhooks > Log ). The log contains a list of recent events and resulting https responses. A previously triggered webhook can be resent by clicking the Resend button on the far right.

Register for a Webhook in LOCATE

  1. Log in to LOCATE
  2. Navigate to Setup > Webhooks
  3. Click New Webhook
  4. Enter the event that will trigger the webhook to fire, and the url to POST to.

Setup Webhooks with the API

Webhooks can be easily be programatically managed with standard CRUD calls to “/webhook” as listed in our API Reference. Make a GET request to “/event” to see a list of events with associated event_ids.

GET /event

Once we have an event_id we can create our webhook:

curl https://company.locateinv.com/webhook \   
-X POST \
-H "Content-type: application/json" \
-H "Authorization:Basic MmNmZTVkOWQxNDJmMDlhNDA2MGRjODYyOWU5Y2JmNTI6MmNmZTVkOWQxNDJmMDlhNDA2MGRjODYyOWU5Y2JmNTI=" \
-d '{
    "url": "https://en6sj11842pt3.x.pipedream.net/",
    "event_id": "1"
}'
/**
* Response
*/
{
  "created_at": "2019-04-23T22:54:28+00:00",
  "event_id": 1,
  "id": 14,
  "updated_at": "2019-04-23T22:54:28+00:00",
  "url": "https://en6sj11842pt3.x.pipedream.net/"
}