1. Home
  2. Developers
  3. Webhooks & GatherUp

Webhooks & GatherUp

GatherUp offers Webhooks.

Webhooks can push information to your endpoint – rather than requiring you to pull information via our API. Gatherup will send this notification as an HTTP POST request, with a JSON body, to the endpoint(s) you specify.


What is a Webhook?

A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately.

What is the difference between Webhook and API?

An API has to constantly check for updates. Generally those checks are scheduled to happen every minute, every hour or every day. A Webhook we’ll let you know the instant an update happens. In GatherUp this is generally when feedback has been received from a customer.


Outbound – Sending feedbacks received into your System

GatherUp offers the ability to send data as HTTP Post to a URL that you specify. We currently support either HTTP or HTTPS URLs, so you can increase security by using an SSL-enabled URL.

We will send the feedbacks received data as JSON – see example below:

{
“rating”:5,
“recommend”:10,
“feedbackId”:”50608244″,
“businessId”:”3376″,
“body”:”The Avocado Sandwich was the best I ever had in my life”,
dateOfReview”:”2018-12-14T23:06:12+02:00″,
“showReview”:”1″,
“authorEmail”:”joesmailth@email.com”,
“authorName”:”Joe S.”
}

All you need to do is process this data being received at your URL.

To utilize this feature simply let support@GatherUp.com know your business name in Gatherup and the URL on your end that should receive the data.


Inbound – Sending Customer information into GatherUp

GatherUp has the ability to ingest Webhooks that contain customer or other information. A common use case is to create a new customer via Webhook.

The Webhook would need to contain the following information:

  • Business ID
  • ​First Name
  • ​Last Name
  • ​Email
  • ​Mobile Phone (optional)
  • ​Job ID (optional)

To have GatherUp listen for your data please send an example payload URL to support@GatherUp.com and we will get in touch with you.


In addition to Webhooks we also offer: JSON endpoint, Rest API and Zapier integration.

Updated on December 17, 2018

Was this article helpful?

Related Articles