Sharing Personalized API Documentation
Hubhus provides personalized API documentation that is automatically tailored to your account. It includes your campaigns, fields, select options, and example payloads, making it easy to give external partners accurate integration details.
On this page
Jump to any section using the links below
Hubhus provides personalized API documentation that is automatically tailored to your account. It includes your campaigns, fields, select options, and example payloads, making it easy to give external partners accurate integration details.
This article explains how to access, share, and restrict access to your API documentation.
1. Accessing your API documentation
Table of Contents
You can open your personalized API documentation directly from your Hubhus account:
Go to Account → API Documentation
Click “Go to the new API documentation here”
The documentation will open in a new window.
You can also access it via a direct link:
Replace YOUR_ACCOUNT_NAME with your Hubhus account name.
2. Sharing the documentation with external partners
You can share the documentation link with developers, integrators, or other partners.
To copy the shareable link:
Open the API documentation page
Click the small link icon in the top of the page
Select Link
Copy the URL
This URL can be safely shared with external users. It only provides access to API documentation, not to your account data.
3. Restricting which data external partners can access
Sharing the documentation does not automatically grant access to all data.
You decide exactly which data an external partner may fetch.
Hubhus allows you to apply campaign filters to restrict API access.
To create a restriction:
Open the relevant campaign
Go to Settings → Filters
Create a new filter
Define your rules — for example:
Only leads created after a specific date
Only a specific partner
Only certain statuses
Only specific tags
Save the filter
Then:
Go to your API documentation
Scroll to the bottom of any endpoint
Select your filter under “Apply filter”
External partners will now only receive data that matches your filter.
This provides a simple way to ensure data access is controlled, auditable, and limited to only what is needed.
4. Inside the personalized API view
Your Hubhus API documentation is dynamically generated based on:
Your API token
Your campaign list
Your custom fields
Your select fields and available options
Your lead structure
Your permissions
The documentation layout:
Left menu
A navigation panel containing sections such as Introduction, authentication, lead endpoints, booking endpoints, and examples.
Middle panel
Interactive options for selecting fields, parameters, or filters.
Right panel
Live-updating JSON examples showing how requests should be structured.
This makes it easy for partners to build valid requests without guessing field names or payload structure.
5. Example: Creating a lead via API
Here is a typical example from the documentation:
Authentication header
Every request must include:
Without a valid token, the API will reject the request.
6. Summary
Hubhus provides personalized API documentation for your account.
It can be accessed and shared from Account → API Documentation.
You can restrict access to data using campaign filters.
The documentation automatically includes your campaigns, fields, and examples.
External partners can use the provided examples to integrate correctly and safely.
? Common searches
api setup • api integration • webhook setup • api authentication
? Also known as
integration • webhook • endpoint
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article