How To Create A Web Hook

A Web Hook is a special type of Bip that can be called on demand from an external application, kind of like your own personal API.  They can pause or delete after a certain time or impressions volume and are great for orchestrating multiple services with a payload defined by you.

To create a web hook :
  • Go to 'My Bips'
  • Click '+ Create A Bip'
  • Click 'Create New Event'
  • Select 'Incoming Web Hook'


Out of the box, web hooks come with two exported variables which are 'title' and 'body', although they can accept and process any JSON payload.

To map an attribute from the hook to another service call, the template should be of the form [%source#json_path%].  Find out more about templating in the open source wiki

Naming Your Hook


Once created, Web Hooks will be reachable via http(s)://{domain name}/bip/http/{hook name}.  The URL of the bip can also be found by clicking the link icon next to it's name.

Creating a Web Hook without giving it a name is fine, a short unique name will be given to it by the system instead.

Attachments


Web Hooks can accept file uploads which will appear as files for processing by your Bip.  Certain Actions such as saving a file to Dropbox or Google Drive (plus others) will automatically detect files uploaded to your Web Hooks and process them accordingly.

Testing


See the Knowledge Base Article - Testing Webhooks.

Customizations


Web Hooks behave a little differently to regular event triggers in that they are passive and only take action when they are called by a connecting HTTP client.  With this in mind there's a few other attributes you might want to configure.

Authentication


Web Hooks can authenticate clients over HTTP Basic Authentication.  Use the 'Auth' tab to configure authentication settings.
  • None : No Authentication
  • Use My API Token (default) : Uses your own system credentials to authenticate clients
  • Basic (recommended) : Use a custom Username/Password pair

Request Parser


Incoming Web Hooks generally won't have any knowledge of the data structures they're posted.  You can hint to your Web Hooks what the expected structure is by pasting a sample JSON payload into the Parser tab.  Bip.io will use this structure to discover attributes which can be composed for other services.

Reponders


Responders are a way for Web Hooks to respond to connecting clients with private data generated or stored by your Saved Actions, or give limited access to your protected resources.  Available Responders for your hook can be found under the 'Responder' tab

Here's an example of taking a private RSS feed container, and making it publicly accessible with a Web Hook, using no authentication and an RSS Syndication response






Feedback and Knowledge Base