Webhooks allow you to receive notifications of BDOW! events via HTTP callbacks and are a great way to support integrations with custom applications. A site on the Plus plan can set up a webhook, and then BDOW! will deliver data to your server every time you capture a new contact!

Enabling the Webhooks Feature

Log into your site manager
Access the Settings page by clicking your user icon in the upper-right and selecting Settings
Click the Integrations tab, then scroll down to the bottom of the page
Use the toggle to enable the webhook

Configuring Your Webhook

On the BDOW! side, all you need to configure is the endpoint URL. Just copy and paste it into the Webhook URL field and click Send Test.

If the test is successful, you will see the test event payload on your server:

{
  "eventType": "FORM_SUBSCRIPTION",
  "eventDate": "2024-08-15T15:09:22.444Z",
  "email": "[email protected]",
  "siteId": "ac6c...3800",
  "executionContext": "TEST",
  "metadata": {}
}

With the test completed, just click Save to complete the configuration. Your BDOW! webhook is live!

Payload Objects

The properties of the payload object will vary depending on the webhook event.

Ping Event

This event is sent as a test to verify that the endpoint is alive and can properly receive messages.

`eventType`	`string`	Value: `PING`
`eventDate`	`string`	Timestamp of the event in UTC format

Form Subscription Event: LIVE Variant

This event is sent after a new contact subscribes via any of the site's campaign forms. It includes a metadata object capturing the form's field data.

`eventType`	`string`	Value: `FORM_SUBSCRIPTION`
`eventDate`	`string`	Timestamp of the event in UTC format
`email`	`string`	Email address of the new contact
`siteId`	`string`	Unique BDOW! site identifier
`formId`	`string`	Unique identifier of the campaign form
`executionContext`	`string`	Indicates the event variant. Value: `LIVE`
`metadata`	`object`	A JSON object containing the form's specific field names and values

Form Subscription Event: TEST Variant

This event is sent via the Send Test button on the webhook configuration page.

`eventType`	`string`	Value: `FORM_SUBSCRIPTION`
`eventDate`	`string`	Timestamp of the event in UTC format
`email`	`string`	Value: `[email protected]`
`siteId`	`string`	Unique BDOW! site identifier
`executionContext`	`string`	Indicates the event variant. Value: `TEST`
`metadata`	`object`	Value: `{}`

Troubleshooting Your Webhook

If the test is unsuccessful, you will see an alert indicating that the webhook endpoint is unreachable. The two most common problems are an incorrect URL or an inaccessible server.

First, verify that the endpoint URL has been entered accurately. If so, it is very likely that a server-side configuration issue is preventing communication. Double-check any items that could interfere with web traffic. For example, firewall restrictions could be blocking BDOW!'s ability to reach the endpoint, or the server's DNS records may be missing or incorrect.