Setting Webhook in Growth Scenario
Follow
Introduction
A webhook is a feature within Growth Scenario that allows events related to users passing through specific nodes to be sent to the customer's server. Through this feature, the customer can also receive data on users passing through specific nodes within Growth Scenario.
Webhook integration
To integrate Webhook you need
- Setting URL endpoint
- Receive HMAC SHA-256 key
- Setting HTTP Header
- Create a Template for receiving data
URL endpoint
You can enter the server URL address that will receive the webhook data. The data transfer supports both GET and POST types.
HMAC SHA-256 key
The UUID key is used to authenticate the webhook data sent by us. Using this key, the customer can verify whether the webhook data transmitted by DFINERY is valid.
HTTP Header
You can set the headers to be included in the webhook request.
The ABX WEBHOOK CREDENTIAL is a mandatory field. The value passed to ABX WEBHOOK CREDENTIAL is the encrypted value of the data set in the template (either the request body or querystring values) using the HMAC SHA-256 key issued earlier. The receiving server encrypts the value using the same method and compares it to verify the validity of the data.
Create a Template
You can set the data to be sent through the webhook. Depending on the data transfer method, it can be divided into JSON (POST) or Querystring (GET). You can set this data using the predefined Adbrix macros and the custom macros set by the customer.
Adbrix macro list
These are macros predefined in Adbrix. When you enter these macros, the values are automatically filled in based on the user's information and transmitted.
Adbrix macro list
Macro name | Note | Example |
{abx:adid} | User device's GAID / IDFA value | 8e10e13a-e738-4aed-bed8- 08d7cd092d7b |
{abx:idfv} | User device's IDFV value | DE4BF1F6-0D95-4F94-A56C-B94E30EB73FE |
{abx:ad_id_opt_out} | User device's GAID usage | false |
{abx:is_push_enable} | App's push usage | true |
{abx:is_push_enable_os} | User device's push usage | true |
{abx:os} | User device's OS version | 16.4 |
{abx:model} | User device's model name | SM-N981 |
{abx:vendor} | User device's manufacturer | Samsung |
{abx:resolution} | User device's resolution | 2400 x 1080 |
{abx:is_portrait} | User device's orientation | true |
{abx:platform} | User device's platform | 1 : Android / 2 : iOS / 3 : Web |
{abx:network} | User device's current network | wifi |
{abx:carrier} | User device's carrier | SKT |
{abx:language} | User device's language | kr |
{abx:country} | User device's country | ko |
How to use Custom Macro
Custom macros are macros set directly by the customer. You can use these custom macros as follows:
Example : If a user sets {custom_macro} as shown in the screenshot below:
In the Growth Scenario webhook settings, you can directly enter the value corresponding to a specific node to send that value through the webhook.