WebHook
Jitsu supports any HTTP destinations. WebHook destination can send configurable HTTP requests based on input JS/API event objects. For instance WebHook destination can send notifications about important conversion events to Slack or another notification channel. URL and Body might be configured with JavaScript. It allows enriching HTTP request with data from JS/API events.
Filtering events#
For filtering events stream to prevent sending all events to WebHook table_name_template is used.
For more information see Table Names and Filters.
Configuration#
WebHook Configuration Parameters#
| Parameter | Description |
|---|---|
url (required) | HTTP URL. Can be a string constant or JavaScript |
method | HTTP method. Optional. Default value is: GET |
body | HTTP request JSON body. Can be a JSON constant or JavaScript returning Object |
headers | HTTP headers Map. All HTTP requests will be enriched with configured HTTP headers. |
JavaScript support#
JavaScript code runs in a context where Jitsu put incoming event as global variables event and short convenient synonyms $ or _
//all 3 expressions are equivalent:
event.event_type
$.event_type
_.event_type //this one better suits Template literals `Welcome, ${_.user?.name}!`Jitsu automatically converts returned value to the type expected by underlying destination property:
- text string ā HTTP URL
- JSON ā for HTTP JSON Body
Select WebHook URL based on event parameters#
Choose different URL for error events:
if ($.event_type === "error") {
return "https://hooks.example.com/notify/error"
}
return "https://hooks.example.com/notify/event"Build WebHook JSON Body#
With javascript you can simply return Object where JSON is expected - it will be automatically converted
return {
"blocks": [
{
"type": "header",
"text": {
"type": "plain_text",
"text": ` ${_.metric_type} event on ${_.doc_host}`
}
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": `*${_.metric_type}* event happened on ${_.url}`
}
}
]
}Server Yaml configuration#
In server's yaml configuration final WebHook setup may look like this:
destinations:
my_webhook:
only_tokens:
- abc.example
type: webhook
mode: stream
data_layout:
table_name_template: '$.event_type' #Optional. It is used for filtering events.
config:
body: |-
return {
"blocks": [
{
"type": "header",
"text": {
"type": "plain_text",
"text": ` ${_.metric_type} event on ${_.doc_host}`
}
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": `*${_.metric_type}* event happened on ${_.url}`
}
}
]
}
method: POST
headers:
authorization: <my_authorization_token>
content-type: application/json
url: |-
if ($.event_type === "error") {
return "https://hooks.example.com/notify/error"
}
return "https://hooks.example.com/notify/event"Slack Example#
WebHook destination will send only conversion events with constructed body to Slack:
destinations:
slack_conversion_webhook:
type: webhook
mode: stream
webhook:
url: https://hooks.slack.com/services/T1DBYWPEWA/A2184KHBDSA/d2ONDSao431bF
method: POST
body: |-
{
"blocks": [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": `User ${_.user?.email} has created order #${_.conversion.order_id}: ${_.conversion.price} ${_.conversion.currency}!`
}
}
]
}
headers:
content-type: application/json
data_layout:
table_name_template: '_.event_type == "conversion" && _.event_type' #Consumes only conversionsData Masking#
You can remove sensitive data from payload before sending it to the webhook:
//simple Data Masking: filter event from all email occurrences
var emailRegexp = /^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$/
function removeEmails(obj) {
for (const key in obj) {
if (typeof obj[key] === "object") {
removeEmails(obj[key])
} else if (typeof obj[key] === "string" && obj[key].match(emailRegexp)) {
delete obj[key]
}
}
}
removeEmails($)
return $