Set Up an Audience Webhook Destination

Last Updated: September 27, 2023

🔍 Please note: this article is for customers on Standard Bundle, Enrichment, or Clearbit Platform plans.

Our Webhook Destination allows you to send segment matches anywhere you need to. When enabled, Clearbit will post a JSON payload to the URL you specify. The payload includes data about the company/person that matched as well as metadata about the destination and segment.

Skip Ahead to:

• Example JSON Payload
• Enable the Destination

Example JSON Payload

📝 Please note: While the format will be the same, the attributes available will differ depending on which you choose to include.

"context": {
  "destination_id": "ID",
  "segment_id":"ID",
  "segment_name":"Test Segment",
  "segment_type":"company",
  "timestamp":"2019-09-20T23:12:49.679+00:00",
  "trigger":"segment_enter"
},
"company": {
  "domain":"clearbit.com",
  "name":"Clearbit",
  "logo":"https://logo.clearbit.com/clearbit.com",
  "enrichment": {
    "name":"Clearbit",
    "domain":"clearbit.com",
    "metrics": {
      "employees_range":"51-250"
    }
  },
  "traits": {
    "paid":true,
  },
  "events": {
    "page_views":[
      {"host":"clearbit.com",
      "path":"/reveal-demo",
      "timestamp":"2019-09-20 23:10:10 UTC"
      },
      {"host":"clearbit.com",
      "path":"/customers/frameio",
      "timestamp":"2019-09-20 23:02:15 UTC"}
    ]
  }
}

Enable the Destination

1. Navigate to any audience in Clearbit.
2. Click the Destinations tab.
3. Click the Create button in the Webhook box, and a pop up will appear.
   
   
4. Select one of the options in the Trigger box, which sets the criteria for a person/company to trigger the destination:
   
   • When a company enters the audience
     • Triggers only when a company/person enters the audience.
   • When a company exists the audience
     • Triggers only when a company/person exits the audience. 
   • On page view
     
     • Triggers every time company/person views a page on your site.
5. In the Configure webhook options section, enter the URL you want Clearbit to send the JSON payload to.
6. Decide if you want to Enable Delivery Suppression. When enabled, people/companies that you've been alerted to within the past x days/weeks/months will be excluded. In the image below, a company would only trigger the Destination if they haven't triggered one in the past 5 days.
   
   
7. Customize your Payload - Allows you to specify exactly which attributes you want to send via webhook.
   
   
8. Click the Save changes button.