CallRail webhook setup - chuwy/snowplow-ci GitHub Wiki

HOME > SNOWPLOW SETUP GUIDE > Step 2b: setup a Webhook > CallRail webhook setup

• 1. Overview
  • 1.1 Compatibility
• 2. Setup
  • 2.1 CallRail
  • 2.2 Snowplow Redshift

This webhook integration lets you track completed telephone calls logged by [CallRail] callrail-website.

For the technical implementation, see Callrail webhook adapter.

• [Snowplow 0.9.11] snowplow-0.9.11+ (POST-capable collectors only)
• [CallRail webhook API] callrail-webhooks as of 1 November 2014

Integrating CallRail's webhooks into Snowplow is a two-stage process:

1. Configure CallRail to send events to Snowplow
2. (Optional) Create the CallRail event table into Amazon Redshift

Configuration in CallRail is on a per-company basis, therefore you will need to configure the CallRail webhook for each company that you want to track calls for.

First login to CallRail. Now select a Company from the dropdown list in the CallRail UI.

Select Integrations -> Webhooks in the submenu and you should see a screen like this:

You can safely ignore the Pre-Call Webhook URL input box; we are only going to track call complete events.

For the Post-Call Webhook URL, you need to provide the URI to your Snowplow Collector. We use a special path to tell Snowplow that these events are generated by CallRail, thus:

http://<collector host>/com.callrail/v1?aid=<company code>

The &aid= name-value pair in your URI's querystring is optional; this is the app_id parameter taken from the [Snowplow Tracker Protocol] tracker-protocol. You can use it to specify which company in CallRail these call complete events belong to. Putting it all together, our setup screen now looks like this:

If you want, you can also manually override the event's platform parameter like so:

http://<collector host>/com.callrail/v1?aid=<company code>&p=<platform code>

Supported platform codes can again be found in the [Snowplow Tracker Protocol] tracker-protocol; if not set, then the value for platform will default to srv for a server-side application.

If you are running the Snowplow batch (Hadoop) flow with Amazon Redshift, then you should deploy the call_complete table into your Amazon Redshift.

You can find the table definition here:

• [com_callrail_call_complete_1.sql] call-complete-sql

Make sure to deploy this table into the same schema as your events table.

That's it - with this table deployed, your CallRail call complete events should automatically flow through into Redshift.