Creating Webhook tables

You can configure the webhook table to perform an HTTP action per message (default) or to create code that controls the frequency (for instance, every N messages).

When developing webhook tables, it is useful to use hookbin to develop, and check your webhook before pointing at your true destination.

  1. Navigate to the Streaming SQL Console.
    1. Navigate to Management Console > Environments, and select the environment where you have created your cluster.
    2. Select the Streaming Analytics cluster from the list of Data Hub clusters.
    3. Select Streaming SQL Console from the list of services.
    The Streaming SQL Console opens in a new window.
  2. Select Console from the main menu.
  3. Select the Tables tab.
  4. Select Add table > Webhook.
    The Webhook Table window appears.
  5. Provide a name to the Table.
  6. Enter an HTTP endpoint. The endpoint must start with http:// or https://.
  7. Add a Description about the webhook sink.
  8. Select POST or PUT in the HTTP Method select box.
  9. Choose to Disable SSL Validation, if needed.
  10. Enable Request Template, if needed.
    1. If you selected Yes, then the template defined in the Request Template tab is used for output.
      This is useful if the service you are posting requires a particular data output format. The data format must be a valid JSON format, and use "${columnname}" to represent fields. For example, a template for use with Pagerduty looks like this:
      {
         "incident":{
            "type":"incident",
            "title":"${icao} is too high!",
              "body":{
         "type":"incident_body",
               "details":"Airplane with id ${icao} has reached an altitude of ${altitude} meters."
       }
          }
      }
      
  11. In the Code editor, you can specify a code block that controls how the webhook displays the data.
    For a webhook that is called for each message the following code is used:
    // Boolean function that takes entire row from query as Json Object
    function onCondition(rowAsJson)
    {return true;   // return false here for no-op, or plug in custom
            logic}
    onCondition($p0)
  12. Add HTTP headers using the HTTP Headers tab, if needed.
    Headers are name:value header elements. For instance, Content-Type:application/json, etc.
  13. Click Save Changes.
The Webhook table is ready to be used after the INSERT INTO statement in your SQL query.