What are WebHooks and How to Use Them?

WebHooks are HTTP requests that occur when an event changes within the Zippykind driver’s application.  So let’s say you want your Zippykind account to notify your application or website when your driver marks the delivery ticket ‘successful’, you can easily accomplish this by setting up WebHooks.

Robot touching persons hand - api and webhooks

A common scenario for setting up a WebHook would be if you want to archive the order in your shopping cart platform when your driver marks the delivery ticket successful.  Or perhaps you want to send your customer a text message or email through your own notifications system when your driver marks the delivery ticket as ‘started’, this can also be done using WebHooks.

 Do I need to send through an API request to Zippykind in order to get a WebHook callback?

Some platforms only use WebHooks as a callback and require an API request to be sent before a WebHook can be triggered; however, Zippykind doesn’t require you to send the API request, you can use WebHooks unilaterally.

What format is the WebHook data sent in?

The WebHook data will include some basic information like the event name which will indicate what status the delivery ticket is in, plus the date and some other basic information.  The data will be sent to the endpoint you provide in JSON structure.

WebHooks vs Polling

Polling can be very annoying and very resource intensive.  Polling is when you setup a cron job or a script to ping an endpoint on a recurring basis.  So if your endpoint checks for status changes in the delivery tickets and their have been no changes, the ping was for nothing and only used resources that didn’t need to be used.  This is why many people prefer WebHooks to polling.

Watch our demonstration video below to see how simple we have made it to setup WebHooks in your Zippykind account.  You can learn more about our WebHooks through our API documentation.