Getting StartedAPI Reference
Getting StartedAPI Reference
  1. Getting Started
  • Getting Started
  1. Getting Started

Getting Started

This documentation is designed to help partner platforms integrate with InboundIQ quickly and with minimal effort.
InboundIQ makes identifying and converting high-intent prospects seamless by combining AI-driven outreach with real-time intent signals.

Quick Integration#

1
Sign up
To get the Inbound IQ B2B API key add your card here and fetch the API key.
2
Onboard Business
Use the Onboard Business API to create a user profile and onboard the business for outreach. Our AI-powered evaluation determines if we can run campaigns effectively for the given website and sends a webhook website.eligibility
3
Embed the InboundIQ Iframe
The webhook website.eligibility, or the API Authenticate User, returns a secure login URL. This URL can be embedded directly into your application using an iframe:
<iframe src="url" title="InboundIQ"></iframe>
4
Send Visitor Data
Use the Send Visitors API to seed the initial outreach database using visitor or intent data from your tracking system. This data is continuously enriched and evolved using AI as responses are received.
5
Wait and prospects will be shown in your iframe's inbox

Beyond quick integration#

Payment#

The first three prospects delivered are free.
After the third prospect, campaigns automatically pause until explicitly re-enabled using the Toggle Campaign Status API.
This API should typically be called after receiving a successful payment webhook from your payment gateway.
Prospect delivery is billed from your wallet. Maintaining a minimum wallet balance is required to avoid interruptions in prospect generation.
InboundIQ sends a prospect.created webhook whenever an interested prospect is identified.

The iframe#

The InboundIQ iframe significantly reduces integration effort by handling:
User onboarding
Prospect chat interface
Communication routing between your user and the prospect
This allows you to offer a fully functional prospect engagement experience without building complex UI or backend flows.

Sending Visitor#

Providing visitor data or existing intent signals substantially improves outreach performance.
InboundIQ combines this data with an AI-powered scoring and enrichment system, continuously refining and enhancing leads to ensure high-quality, relevant outreach.

Authentication#

All API requests must be authenticated using an API key.
Pass your API key in the request header as shown below:
x-api-key: <YOUR_API_KEY>
Requests made without a valid API key will be rejected with an authentication error.

Rate Limits#

All API endpoints are subject to a rate limit of 100 requests per second per API key.
If the rate limit is exceeded, the API responds with HTTP 429 Too Many Requests.
Rate limit information is returned using standard RateLimit-* response headers, allowing clients to track usage and implement backoff behavior.
Modified at 2025-12-11 18:38:28
Built with