What is a WebHook?

The concept of a WebHook is simple. A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST.

A web application implementing WebHooks will POST a message to a URL when certain things happen. When a web application enables users to register their own URLs, the users can then extend, customize, and integrate that application with their own custom extensions or even with other applications around the web. For the user, WebHooks are a way to receive valuable information when it happens, rather than continually polling for that data and receiving nothing valuable most of the time. WebHooks have enormous potential and are limited only by your imagination! (No, it can't wash the dishes. Yet.)

Read more about WebHooks here.

How to get Started

WebHooks are currently only available to resellers. To enable WebHooks for your account, login to the administration panel and navigation to Accounts / Settings. Fill in the WebHook URL text field with the URL you wish to receive the request and click "Save Account Settings".

From now on, any new sign up will trigger a notification to be sent to your WebHook URL!

What the Request Looks Like

The request is sent as an HTTP POST. The parameters are:

  • action - a static value of "signup"
  • name - the name of the newly created account's admin
  • url - the URL to the newly created account
  • service - the reseller account's name

That's it! The URL specified in the administration panel will receive the request, what happens from there is up to your server.