.png)
Webhook connector
Introduction
You can set up one or more Webhooks in order to allow external applications to receive information about contact events as they occur within Grow. This documentation will detail configuring and testing webhooks, as well as information about authentication, failed batches, message formats, and more.
Event Types
- Contact Subscribes: contact has subscribed to your list via an on-site campaign
- Contact Unsubscribes: recipient has unsubscribed
Data Set
We make the following data available for every contact event we post towards your external system:
Title |
Description |
Attribute key |
Type |
Sample values |
| Phone Number | The phone number of the contact acquired | msisdn |
LONG | 5599999999999 |
| Acquisition date | The timestamp of the contact’s 1st acquisition | profileCreatedAt |
TIMESTAMP | 2022-11-24T09:59:41.163Z |
| Acquisition source | The source of acquiring the contacts | source |
TEXT | form, keyword, mobile_identity, import |
| Acquisition details | The acquisition details of acquiring the contact | source_value |
TEXT | Per source details · form: onsite_campaign_id · keyword: automation_id · mobile identity: onsite_campaign_id · import: csv, orders |
| Opt-in status | The contact consent in the eshop to receive marketing by Grow | eshop_opt_in |
BOOLEAN | true, false |
| Last optin date | The timestamp of the last optin in the eshop | last_eshop_opt_in_date |
TIMESTAMP | 2023-11-16T11:33:29.485Z |
| The latest provided email in the form | ecom_email |
TEXT | test@gmail.com | |
| Signup count | The number of signups in the eshops | ecom_signups_count |
LONG | 2 |
| Device type | The device type where the contact subscribed | ecom_device_type |
TEXT | mobile, desktop |
| Browser name | The browser name where the contact subscribed | ecom_browser_name |
TEXT | Chrome |
| Locale | The browser locale where the contact subscribed | ecom_locale |
TEXT | pt-br |
| Timezone | The browser time zone where the contact subscribed | ecom_timezone |
TEXT | UTC-03:00 |
| Operating system | The operating system that the contact subscribed | ecom_os_name |
TEXT | Android |
| Signup domain | The latest signup domain | ecom_signup_domain |
TEXT | www.websitedomain.com.br |
| Signup path | The latest signup path | ecom_signup_path |
TEXT | /, /lancamentos |
| Signup Referrer URL | The latest signup referrer UR | ecom_signup_referrer_url |
TEXT | https://www.google.com |
| Last order date | The timestamp of the last order | last_order_date |
TIMESTAMP | 2024-09-26T00:08:18.161Z |
| Total orders | Total orders count the contact has performed in the eshop | ecom_total_order_count |
LONG | 6 |
| Total orders amount | The total amount of all orders the contact has performed in the eshop | ecom_total_order_amount |
LONG | 832 |
| Last click date | The latest date a contact clicked on any message | last_click_date |
TIMESTAMP | 2023-10-03T07:58:18.893Z |
Setting up a Webhook
You can configure a new webhook via your Grow account Integrations page:
- Navigate to “Integrations” from the left hand side menu.
- Select "Marketing" and then click to “Connect” a new Webhook.
- On the next page, you can see the list of your configured webhooks. If you are setting up your first Webhook, the list will appear empty.
- Click on the "+ Webhook" button on the top right corner to add a new one.
- In the next step you will be prompted to add a Name (this is for internal use only) and then the Webhook URL you have generated from the external system you wish to connect with Grow.
- Click Save to create your new Webhook.
Note: Multiple webhooks can be configured to enable syncing contacts with more than one external application.
Test if your Webhook connection is working properly
Once you have saved your new webhook you can perform a quick test to validate that the connection is working properly.
- Please locate the new Webhook you have set up and access the “Test connection” option on the right side of the screen under the 3-dots menu.
- Once you click on “Test connection” you will see a sample data set, which you can edit and then click “Send” in order to perform the test.
- In case the test is successful you’ll see the following screen.
- If your test returns an error you’ll see the following message.
Troubleshooting
If the webhook URL does not return a 200 HTTP response code, the POST request will be retried up to three times. If all three attempts fail, the request will be marked as a failure in the application.