ZoomInfo Monitoring API/Webhooks API
ZoomInfo data is highly dynamic, with contacts, companies and related data being constantly updated in real-time in our database. Naturally, our clients want these changes to be delivered in real-time for the records they've already purchased using the ZoomInfo API - that's where webhooks come in. ## Why webhooks? Organizations with ZoomInfo API access use the API's endpoints to search for, export, and enrich records to their integrated applications. While you can regularly poll for updates to contact and company records you've already enriched using the API, manually querying the entire database is not the best use of your time. A more efficient method is to configure webhooks to automatically update you when there is a change to a record youve purchased. Once configured, Webhooks will listen for events you subscribe to and automatically send over all (or only relevant) updates securely to your application. ## Monitoring API/Webhooks basics Available to organizations with the Scaling API, the Monitoring API is a set of endpoints that allows for the configuration of webhooks subscriptions that specify: - **Webhook Title**: Name of the webhook. - **Subscription**: The events you are listening for, consisting of object types and event types. - **Object types**: The types of records you want to update. Supported object types are Contact and Company. - **Event types**: The events that trigger a webhook's response. Currently, the only supported event is Update. - **Changed attributes**: This is a JSON object that includes a list of fields that are changed as part of a payload. - **Payload types (full payload/changed attributes only)**: - A full payload (all fields for a contact or company, including changed attributes) - Only the changed attributes for a contact or company. - **Target URL**: The target URL to which the webhook JSON payloads are sent. - **Verification Token**: Signature token that will be part of the request we send to you. ## Securing the data transfer To secure communication between ZoomInfo and your app, a _verification token_ is generated when you create the webhook. When data is sent to your target URL using a POST request, this verification token will be included in the request header (_x-zoominfo-token_) and can be used in your app to authorize receipt of the data from ZoomInfo. The initial token is generated when you create a webhook. To maintain security for your webhook over time, you can periodically generate a new verification token using the [Generate Verification Token](#9cc75e99-622e-4aa2-b9a8-2d33d0ede2ed) webhook. ## Considerations Note the following considerations: - To use the Monitoring API/webhooks, you must have access to the Scaling API. - To subscribe to events, you must have already enriched at least one contact or company record using the API. - You will only receive updates on records that you've purchased using the API within the past 12 months. - The default payload type for company or contact updates is the full payload with changed attributes. - The maximum number of profiles delivered in a single webhook payload is 25. ## Payload examples Here are examples of the POST requests your webhook's target URL will receive. For contact and company records, you can choose to receive a full payload of all possible fields for a record (including changed attributes), or a payload including only the changed attributes for a record. In either case (full or changed attributes only), contact and company records will always include the following fields to support mapping the profile: **Contacts**: `id`, `firstName`, `lastName`, and `email` **Companies**: `id`, `name`, and `website` The following examples are provided below: - Example 1: Contact record - full profile (default) - Example 2: Contact record - changed attributes only - Example 3: Company record - full profile (default) - Example 4: Company record - changed attributes only **Example 1: Contact record - full profile (default)** Includes all output fields ``` json { "webhookDetails": { "id": "xxxx", "title": "webhook-title", "objectType": "Contact", "eventType": "Update" }, "data": [ { "id": 1260398587, "firstName": "Henry", "middleName": "L.", "lastName": "Schuck", "email": "henry.schuck@zoominfo.com", "hasCanadianEmail": "false", "phone": "(360) 783-6816", "directPhoneDoNotCall": false, "street": "805 Broadway St Ste 900", "city": "Vancouver", "region": "Washington", "metroArea": "Portland", "zipCode": "98660", "state": "Washington", "country": "United States", "continent": "North America", "personHasMoved": "Uncertain", "withinEu": false, "withinCalifornia": true, "withinCanada": false, "validDate": "01/09/2023 07:26 PM", "lastUpdatedDate": "1/5/2020 7:59 PM", "noticeProvidedDate": "06/27/2020", "salutation": "", "suffix": "", "jobTitle": "Founder & Chief Executive Officer", "jobFunction": [ { "name": "Executive", "department": "C-Suite" } ], "education": [ { "school": "University of Nevada , Las Vegas", "educationDegree": { "degree": "", "areaOfStudy": "" } }, { "school": "Oxford University", "educationDegree": { "degree": "comparative law", "areaOfStudy": "" } }, { "school": "The Ohio State University Moritz College of Law", "educationDegree": { "degree": "", "areaOfStudy": "juris doctorate degree cum laude" } } ], "picture": "https://www.zoominfo.com/wp-content/uploads/2020/06/henry.png", "techSkills": [ { "id": 92113, "name": "Microsoft Access" }, { "id": 112883, "name": "Forrester" }, { "id": 31687, "name": "Wave" }, { "id": 68842, "name": "engage" } ], "mobile": "", "personalEmail": "", "mobilePhone": "(818) 679-4647", "supplementalEmail": "henry.schuck@gmail.com", "mobilePhoneDoNotCall": false, "externalUrls": [ { "type": "linkedin.com", "url": "https://www.linkedin.com/in/hschuck" }, { "type": "twitter.com", "url": "https://www.twitter.com/henrylschuck" } ], "contactAccuracyScore": 94.0, "isDefunct": false, "employmentHistory": [ { "jobTitle": "Vice President of Data and Marketing", "managementLevel": [ "VP-Level" ], "fromDate": "2002-01-02T00:00:00.000Z", "toDate": "2006-01-02T00:00:00.000Z", "company": { "companyId": 0, "companyName": "iProfile", "companyPhone": "", "companyWebsite": "" } } ], "managementLevel": [ "C-Level" ], "locationCompanyId": 344589814, "positionStartDate": "", "yearsOfExperience": "20-29", "company": { "division": "", "id": 344589814, "name": "ZoomInfo", "descriptionList": [ { "description": "ZoomInfo was founded in 2000 and is headquartered in Vancouver, Washington. The company offers a business-to-business data platform utilized by sales and marketing teams, recruiters, and other business professionals for lead generation and detailed information on people and companies." } ], "phone": "(866) 904-9666", "fax": "(617) 507-8187", "street": "805 Broadway St Ste 900", "city": "Vancouver", "state": "Washington", "zipCode": "98660", "country": "United States", "continent": "North America", "logo": "https://res.cloudinary.com/zoominfo-com/image/upload/w_100,h_100,c_fit/zoominfo.com", "sicCodes": [ { "id": "27", "name": "Printing, Publishing, And Allied Industries" }, { "id": "274", "name": "Miscellaneous Publishing" }, { "id": "2741", "name": "Miscellaneous Publishing" }, { "id": "73", "name": "Business Services" }, { "id": "738", "name": "Miscellaneous Business Services" }, { "id": "7389", "name": "Business Services, Not Elsewhere Classified" }, { "id": "737", "name": "Computer Programming, Data Processing, And Other Computer Related Services" }, { "id": "7375", "name": "Information Retrieval Services" }, { "id": "7374", "name": "Computer Processing and Data Preparation and Processing Services" }, { "id": "89", "name": "Miscellaneous Services" }, { "id": "899", "name": "Miscellaneous Services" }, { "id": "8999", "name": "Services, Not Elsewhere Classified" }, { "id": "7372", "name": "Prepackaged Software" } ], "naicsCodes": [ { "id": "54", "name": "Professional, Scientific, and Technical Services" }, { "id": "541", "name": "Professional, Scientific, and Technical Services" }, { "id": "5416", "name": "Management, Scientific, and Technical Consulting Services" }, { "id": "54161", "name": "Management Consulting Services" }, { "id": "541613", "name": "Marketing Consulting Services" }, { "id": "51", "name": "Information" }, { "id": "519", "name": "Other Information Services" }, { "id": "5191", "name": "Other Information Services" }, { "id": "51919", "name": "All Other Information Services" }, { "id": "519190", "name": "All Other Information Services" }, { "id": "5415", "name": "Computer Systems Design and Related Services" }, { "id": "54151", "name": "Computer Systems Design and Related Services" }, { "id": "541511", "name": "Custom Computer Programming Services" }, { "id": "511", "name": "Publishing Industries (except Internet)" }, { "id": "5112", "name": "Software Publishers" }, { "id": "51121", "name": "Software Publishers" }, { "id": "511210", "name": "Software Publishers" }, { "id": "51913", "name": "Internet Publishing and Broadcasting and Web Search Portals" }, { "id": "519130", "name": "Internet Publishing and Broadcasting and Web Search Portals" }, { "id": "517", "name": "Telecommunications" }, { "id": "5173", "name": "Wired and Wireless Telecommunications Carriers" }, { "id": "51731", "name": "Wired and Wireless Telecommunications Carriers" } ], "website": "www.zoominfo.com", "revenue": "$835.6 Million", "revenueNumeric": 835600000, "employeeCount": 3546, "type": "PUBLIC", "ticker": "NASDAQ: ZI", "ranking": [], "socialMediaUrls": [ { "type": "LINKED_IN", "url": "http://www.linkedin.com/company/zoominfo", "followerCount": "" }, { "type": "TWITTER", "url": "http://www.twitter.com/zoominfo", "followerCount": "14807" }, { "type": "FACEBOOK", "url": "http://www.facebook.com/109325735758217", "followerCount": "" } ], "primaryIndustry": [ "Software" ], "primaryIndustryCode": [ { "id": "software", "name": "Software" } ], "primarySubIndustryCode": [], "industries": [ "Software", "Data Collection & Internet Portals", "Media & Internet" ], "industryCodes": [ { "id": "software", "name": "Software" }, { "id": "media.data", "name": "Data Collection & Internet Portals" }, { "id": "media", "name": "Media & Internet" } ], "revenueRange": "$500 mil. - $1 bil.", "employeeRange": "1,000 - 5,000", "employeeGrowth": { "oneYearGrowthRate": "32.5", "twoYearGrowthRate": "114.1", "employeeGrowthDataPoints": [ { "label": "'20 - Q3", "employeeCount": 1656 }, { "label": "'20 - Q4", "employeeCount": 1845 }, { "label": "'21 - Q1", "employeeCount": 2136 }, { "label": "'21 - Q2", "employeeCount": 2297 }, { "label": "'21 - Q3", "employeeCount": 2677 }, { "label": "'21 - Q4", "employeeCount": 3117 }, { "label": "'22 - Q1", "employeeCount": 3477 }, { "label": "'22 - Q2", "employeeCount": 3549 }, { "label": "'22 - Q3", "employeeCount": 3546 } ] } }, "changedAttributes": [ "jobTitle", "department" ] } ] } ``` **Example 2: Contact record - changed attributes only (default)** Includes only output fields with changed attributes ``` json { "webhookDetails": { "id": "xxxx", "title": "webhook-title", "objectType": "Contact", "eventType": "Update" }, "data": [ { "id": 1260398587, "firstName": "Henry", "lastName": "Schuck", "email": "henry.schuck@zoominfo.com", "department":"C-Suite", "jobTitle": "Founder & Chief Executive Officer", "changedAttributes": [ "jobTitle", "department" ] } ``` **Example 3: Company record - full profile (default)** Includes all output fields ``` json { "webhookDetails": { "id": "xxxx", "title": "webhook-title", "objectType": "company", "eventType": "Update" }, "data": [ { "id": 344589814, "ticker": "NASDAQ: ZI", "name": "ZoomInfo", "website": "www.zoominfo.com", "logo": "https://res.cloudinary.com/zoominfo-com/image/upload/w_100,h_100,c_fit/zoominfo.com", "socialMediaUrls": [ { "type": "LINKED_IN", "url": "http://www.linkedin.com/company/zoominfo", "followerCount": "" }, { "type": "TWITTER", "url": "http://www.twitter.com/zoominfo", "followerCount": "3496" }, { "type": "FACEBOOK", "url": "http://www.facebook.com/109325735758217", "followerCount": "" } ], "revenue": 1210000, "employeeCount": 3500, "phone": "(866) 904-9666", "fax": "(617) 507-8187", "street": "805 Broadway St Ste 900", "city": "Vancouver", "state": "Washington", "zipCode": "98660", "country": "United States", "companyStatus": "ALIVE", "companyStatusDate": "2022-08-23T00:00:00.000Z", "sicCodes": [ { "id": "27", "name": "Printing, Publishing, And Allied Industries" }, { "id": "274", "name": "Miscellaneous Publishing" }, { "id": "2741", "name": "Miscellaneous Publishing" }, { "id": "73", "name": "Business Services" }, { "id": "738", "name": "Miscellaneous Business Services" }, { "id": "7389", "name": "Business Services, Not Elsewhere Classified" }, { "id": "737", "name": "Computer Programming, Data Processing, And Other Computer Related Services" }, { "id": "7375", "name": "Information Retrieval Services" }, { "id": "7374", "name": "Computer Processing and Data Preparation and Processing Services" }, { "id": "89", "name": "Miscellaneous Services" }, { "id": "899", "name": "Miscellaneous Services" }, { "id": "8999", "name": "Services, Not Elsewhere Classified" }, { "id": "7372", "name": "Prepackaged Software" } ], "naicsCodes": [ { "id": "54", "name": "Professional, Scientific, and Technical Services" }, { "id": "541", "name": "Professional, Scientific, and Technical Services" }, { "id": "5416", "name": "Management, Scientific, and Technical Consulting Services" }, { "id": "54161", "name": "Management Consulting Services" }, { "id": "541613", "name": "Marketing Consulting Services" }, { "id": "51", "name": "Information" }, { "id": "519", "name": "Other Information Services" }, { "id": "5191", "name": "Other Information Services" }, { "id": "51919", "name": "All Other Information Services" }, { "id": "519190", "name": "All Other Information Services" }, { "id": "5415", "name": "Computer Systems Design and Related Services" }, { "id": "54151", "name": "Computer Systems Design and Related Services" }, { "id": "541511", "name": "Custom Computer Programming Services" }, { "id": "511", "name": "Publishing Industries (except Internet)" }, { "id": "5112", "name": "Software Publishers" }, { "id": "51121", "name": "Software Publishers" }, { "id": "511210", "name": "Software Publishers" }, { "id": "51913", "name": "Internet Publishing and Broadcasting and Web Search Portals" }, { "id": "519130", "name": "Internet Publishing and Broadcasting and Web Search Portals" }, { "id": "517", "name": "Telecommunications" }, { "id": "5173", "name": "Wired and Wireless Telecommunications Carriers" }, { "id": "51731", "name": "Wired and Wireless Telecommunications Carriers" } ], "competitors": [ { "rank": 1, "id": 168919661, "name": "LinkedIn Corp", "website": "linkedin.com", "employeeCount": 21000 }, { "rank": 2, "id": 5390594, "name": "Dun & Bradstreet Inc", "website": "dnb.com", "employeeCount": 6000 }, { "rank": 3, "id": 464190707, "name": "Clearbit", "website": "clearbit.com", "employeeCount": 198 }, { "rank": 4, "id": 357808721, "name": "SalesIntel Research Inc", "website": "salesintel.io", "employeeCount": 27 }, { "rank": 5, "id": 408702118, "name": "Lusha Ltd", "website": "lusha.com", "employeeCount": 270 }, { "rank": 6, "id": 159335237, "name": "Lead411", "website": "lead411.com", "employeeCount": 17 }, { "rank": 7, "id": 436418998, "name": "UpLead LLC", "website": "uplead.com", "employeeCount": 16 }, { "rank": 8, "id": 429601687, "name": "Seamless AI", "website": "seamless.ai", "employeeCount": 175 }, { "rank": 9, "id": 115098897, "name": "InsideView Inc", "website": "insideview.com", "employeeCount": 312 }, { "rank": 10, "id": 353571907, "name": "6sense Insights Inc", "website": "6sense.com", "employeeCount": 1350 } ], "ultimateParentId": 0, "ultimateParentRevenue": 1210000, "ultimateParentEmployees": 3500, "primaryIndustry": [ "Software" ], "primaryIndustryCode": [ { "id": "software", "name": "Software" } ], "primarySubIndustryCode": [], "industries": [ "Software", "Data Collection & Internet Portals", "Media & Internet" ], "industryCodes": [ { "id": "software", "name": "Software" }, { "id": "media.data", "name": "Data Collection & Internet Portals" }, { "id": "media", "name": "Media & Internet" } ], "parentId": 0, "locationCount": 22, "metroArea": "Portland-Vancouver-Hillsboro OR-WA", "certified": true, "revenueRange": "$1 bil. - $5 bil.", "employeeRange": "1,000 - 5,000", "companyFunding": [ { "date": "2020-06-04T07:00:00.000Z", "type": "Stock Issuance/Offering", "amount": 935000, "investors": [ "" ] }, { "date": "2021-06-18T07:00:00.000Z", "type": "Corporate Investment", "amount": 555, "investors": [ "" ] }, { "date": "2021-08-27T07:00:00.000Z", "type": "Stock Issuance/Offering", "amount": 1200000, "investors": [ "" ] }, { "date": "2017-08-14T00:00:00.000Z", "type": "Private Equity", "amount": 240000, "investors": [ "Great Hill Partners" ] }, { "date": "2004-07-19T00:00:00.000Z", "type": "Series A", "amount": 7000, "investors": [ "Ascent Venture Partners", "Vulcan Capital Management", "Venrock Associates", "Flagship Pioneering", "Commonwealth Capital Ventures" ] }, { "date": "2014-05-30T07:00:00.000Z", "type": "Private Equity", "amount": 0, "investors": [ "TA Associates" ] }, { "date": "2018-03-14T07:00:00.000Z", "type": "Private Equity", "amount": 0, "investors": [ "The Carlyle Group", "22C Capital" ] } ], "totalFundingAmount": 2382555, "employeeGrowth": { "oneYearGrowthRate": "32.4", "twoYearGrowthRate": "114.2", "employeeGrowthDataPoints": [ { "label": "'20 - Q3", "employeeCount": 1634 }, { "label": "'20 - Q4", "employeeCount": 1821 }, { "label": "'21 - Q1", "employeeCount": 2108 }, { "label": "'21 - Q2", "employeeCount": 2267 }, { "label": "'21 - Q3", "employeeCount": 2643 }, { "label": "'21 - Q4", "employeeCount": 3077 }, { "label": "'22 - Q1", "employeeCount": 3432 }, { "label": "'22 - Q2", "employeeCount": 3503 }, { "label": "'22 - Q3", "employeeCount": 3500 } ] }, "type": "PUBLIC", "isDefunct": false, "departmentBudgets": { "marketingBudget": 158510, "itBudget": 44770, "financialBudget": 12100, "hrBudget": 7890 }, "employeeCountByDepartment": { "sales": 1544, "engineeringAndTechnical": 860, "marketing": 242, "informationTechnology": 192, "humanResources": 127, "finance": 95, "operations": 86, "legal": 32, "cSuite": 14, "medicalAndHealth": 1 }, "changedAttributes": [ "revenue", "employeeCount" ] } ] } ``` **Example 4: Company record - changed attributes only (default)** Includes only output fields with changed attributes ``` json { "webhookDetails": { "id": "xxxx", "title": "webhook-title", "objectType": "company", "eventType": "Update" }, "data": [ { "id": 344589814, "name": "ZoomInfo", "website": "www.zoominfo.com", "revenue": 1210000, "employeeCount": 3500, "changedAttributes": [ "revenue", "employeeCount" ] } ] } ```