Webhooks provide a powerful way to capture data from a variety of external sources, allowing you to seamlessly integrate this information with your existing data blend. When a direct integration between your instance and an external service is not available, setting up a webhook integration can serve as an excellent alternative. By using webhooks, you can ensure that data flows smoothly from different platforms into your system in real-time or near real-time, helping you maintain up-to-date and accurate records. This article will guide you step-by-step through the process of configuring a webhook integration, ensuring that you capture the precise data you need for your organization’s purposes.
To get started, go to your Settings page from the menu. Under Connections, click +Add System, then look for Webhook in the list of connections.
Next, in the Add a System modal, you can either search for Webhook or select it from the list of integrations.
A dialog will appear with a generated URL. This URL is what you’ll use in your system to send data. Be sure to copy the URL and save it in a safe place.
When you're ready to send data to the URL from your system, please start by sending a test payload in the usual format you plan to use. This helps create an initial seed to properly map the data within the dataset, allowing it to be smoothly integrated into your organization's data blend.
Mapping the Connection
When you first create the webhook a process will begin initializing the webhook. The connection will be in this state until it receives the initial payload from your platform.
After receiving an initial payload, the status will update to Active. Once that happens, you will be able to map the connection just like any other connection. You will be able to set Inclusion Filters, add Column Mappings, Join Additional Data and create Audiences from the webhook dataset as needed.
After mapping, the webhook data will be joined to the Data Blend when it refreshes and can be used across Avid to create Audiences, Pathways or add new filters to report on.
Things to Consider When Creating a Webhook Integration
Payload Format Matters
The first test payload you send establishes the structure of your dataset in Avid. It doesn't matter what format the payload is in. However, you will want to make sure the payload reflects the format and fields you’ll actually use going forward. Changing the schema later may require remapping or even recreating the dataset.
Authentication & Security
The generated webhook URL is unique to your instance. Treat it like a password—don’t share it publicly.
Monitoring & Maintenance
After setup, keep an eye on webhook activity. Look out for failed deliveries, schema mismatches, or large spikes in event volume. Regular checks will ensure your integration stays up-to-date.