Skip to content

Correct ZoomInfo integration page - #706

Draft
claude[bot] wants to merge 2 commits into
mainfrom
TSP-1326/docs-update
Draft

Correct ZoomInfo integration page#706
claude[bot] wants to merge 2 commits into
mainfrom
TSP-1326/docs-update

Conversation

@claude

@claude claude Bot commented Jul 1, 2026

Copy link
Copy Markdown

Summary

Corrects the ZoomInfo integration page. This PR originally documented the new ZoomInfo GTM (OAuth) integration as available; it is not, so that content has been removed and the existing page fixed instead.

Why the OAuth content was pulled

The zoominfo_gtm provider and all six GTM tool steps are hidden behind the zoominfo-gtm-native feature flag (hideWhen: "when_disabled", default false) in both provider_feature_flag_visibility.ts and studio/transformations/feature_flag_visibility.ts.

The prod flag payload is {"force_internal_usage": true} — no projects map, no organizations map, no wildcard. Evaluated through IsFeatureEnabledForProjectOrOrg, that resolves true only for Relevance employees. No customer can see or connect the integration today, so documenting the OAuth flow, its tool steps, or an early-access path would have been wrong.

The OAuth documentation is written and sits in this branch's history (bbbf1e4). It can be restored once the flag payload has real orgs in it.

What this PR changes

  • Removes four tool step cards that document nothing. Search contacts, Search companies, Enrich contact, and Enrich company are not in the transformation registry. On the credential-based integration, only zoominfo_api_call exists.
  • Describes Zoominfo API call as the single step all ZoomInfo operations run through — search, enrichment, and lookup are reached by pointing it at an endpoint.
  • Drops the "select your connected ZoomInfo account from the dropdown" instruction. zoominfo_api_call has no oauth_account_id field; authorization comes from the project credentials.
  • Replaces the API call example, which used a /companies/enrich endpoint and an include_attributes body that do not exist, with a lookup call taken from the step's own field hint.
  • Removes the "built-in credit safeguards" claim (two places) — no supporting code.
  • Adds one FAQ noting an OAuth version is in development and not yet available. No timeline, no enablement path.
  • Capitalizes Agents and GTM Agents per the docs style rules.

The credential-based connection instructions are unchanged.

Linear issue

https://linear.app/relevance/issue/TSP-1326/

TSP-1326 is not fully closed by this PR — the GTM OAuth documentation is still owed and is blocked on the flag rollout.

Document the new ZoomInfo GTM (OAuth) integration alongside the existing
legacy credential-based integration. Changes include:

- Updated intro to describe both integration methods and note they coexist
- Restructured "Connect the integration" into two subsections: GTM OAuth
  (recommended, marked early access) and legacy credential-based
- Added 6 new GTM tool steps: Search Contacts (GTM), Enrich Contacts (GTM),
  Search Companies (GTM), Enrich Companies (GTM), Taxonomy Lookup, and
  ZoomInfo GTM API Call
- Added parallel "ZoomInfo GTM API Call" advanced section alongside legacy
- Expanded best practices to cover integration method selection and
  OAuth token refresh behavior
- Added 4 new FAQs: GTM vs legacy differences, account type requirements,
  Taxonomy Lookup explanation, and simultaneous use of both integrations

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Jul 1, 2026
@linear

linear Bot commented Jul 1, 2026

Copy link
Copy Markdown

TSP-1326

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Jul 1, 2026, 5:57 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@claude claude Bot changed the title docs(TSP-1326): add ZoomInfo GTM OAuth integration documentation Update ZoomInfo integration docs for GTM OAuth Jul 1, 2026
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 1 file (1 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 7/10 "Agent" is a Relevance AI product proper noun but written lowercase throughout ("your AI agents", "GTM agents"). "Taxonomy Lookup" vs "Taxonomy lookup" inconsistent between Card title and prose.
🟡 Technical clarity 7/10 Both custom API Call sections tell users to configure parameters "according to the ZoomInfo API documentation" but never link to it — Apollo.mdx links out to Apollo's API docs in the same section pattern. Technical users are left to find ZoomInfo's docs themselves.
🟢 Non-technical clarity 9/10 Credit model (search free / enrich costs credits) is explained clearly and reinforced throughout. GTM vs legacy distinction is well framed.
🟢 Structure 9/10 Solid integration page. One numbered list that should be <Steps>.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

Overall vibe: A well-written, well-structured integration page — the credit consumption section in particular is genuinely useful and the GTM vs legacy framing is clear. Main gaps are the "Agent" capitalization inconsistency (present throughout) and a missing link to ZoomInfo API docs that will leave advanced users hunting.

🔧 Issues (6)
  • integrations/popular-integrations/zoominfo.mdx:3 — frontmatter description: "from your AI agents" → "from your AI Agents" — Agent is a Relevance AI product proper noun and should be capitalized when referring to the product feature.
  • integrations/popular-integrations/zoominfo.mdx:7 — "your AI agents can search ZoomInfo's database" → "your AI Agents" — same rule; this is referencing the product feature.
  • integrations/popular-integrations/zoominfo.mdx:147<Card title="Taxonomy lookup"> — the prose throughout the page consistently refers to this as "Taxonomy Lookup" (capitalized, treating it as the proper name of the tool step — e.g. lines 311, 348). Card title should match: "Taxonomy Lookup".
  • integrations/popular-integrations/zoominfo.mdx:217 — "Set the HTTP method, endpoint path, and request body parameters according to the ZoomInfo API documentation." — no link to ZoomInfo API docs. Apollo.mdx links directly to Apollo's API docs in the equivalent step ([Apollo's API documentation](https://apolloio.github.io/apollo-api-docs/)). Same issue on line 265 (legacy equivalent).
  • integrations/popular-integrations/zoominfo.mdx:295 — Accordion title "GTM agent prospect research" → "GTM Agent prospect research" — Agent is the Relevance AI product proper noun.
  • integrations/popular-integrations/zoominfo.mdx:363–364 — FAQ accordion title "Does ZoomInfo work with GTM agents?" and body "compatible with GTM agents in Relevance AI" → "GTM Agents" — same capitalization rule.
🧩 Component suggestions (1)
  • integrations/popular-integrations/zoominfo.mdx:188–196 — "How to add ZoomInfo tool steps to your agent" is a six-step sequential procedure written as a plain numbered list. Every other sequential procedure on this page uses <Steps> (the GTM OAuth setup, the legacy credential setup, both API Call sections). Wrap this in <Steps> for visual consistency and to match the page's own pattern.
✅ Clean files (0)

All issues are in integrations/popular-integrations/zoominfo.mdx.

🔋 Credit usage
Item Count
Files reviewed 1
Context pages read 2
Total lines processed ~888

Files read: integrations/popular-integrations/zoominfo.mdx (375 lines), integrations/popular-integrations/apollo.mdx (165 lines), integrations/popular-integrations/lusha.mdx (348 lines)

The ZoomInfo OAuth provider and its six tool steps are hidden behind the
zoominfo-gtm-native flag, whose payload is {"force_internal_usage": true}
with no project or organization entries — no customer can reach them yet.
Documenting them as available was wrong, so this reverts to the
credential-based integration and fixes the errors on the page instead:

- Remove the Search contacts, Search companies, Enrich contact, and Enrich
  company tool step cards. Those transformations are not in the registry;
  only zoominfo_api_call exists.
- Describe Zoominfo API call as the single step all ZoomInfo operations run
  through, and drop the account dropdown instruction — the step has no
  oauth_account_id field.
- Replace the API call example, which used an endpoint and body shape that
  do not exist, with a lookup call taken from the step's own field hint.
- Remove the unverified "built-in credit safeguards" claim.
- Add an FAQ noting an OAuth version is in development and not yet
  available.
- Capitalize Agents and GTM Agents.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@jordanc-relevanceai jordanc-relevanceai changed the title Update ZoomInfo integration docs for GTM OAuth Correct ZoomInfo integration page Aug 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant