On this page

Jump to any section using the links below

The Hubhus API allows external systems to exchange data with Hubhus programmatically.
It is used to create leads, update fields, trigger workflows, fetch data for dashboards, or integrate Hubhus with other tools such as CRMs, ERP systems, websites, or custom applications.

This article gives a beginner-friendly overview of what the API is, when to use it, and how it compares to alternatives like webhooks and Zapier.

API concept overview

An API (Application Programming Interface) is a structured way for one system to communicate with another.

The Hubhus API allows you to:

• Create or update leads

• Add files

• Post form submissions

• Fetch events, fields, and statuses

• Trigger processes from your own system

• Build custom flows that extend Hubhus functionality

The API is ideal for automating data exchange without manual work.

REST API basics

The Hubhus API is a REST API, which uses standard HTTP methods:

• GET → Retrieve data

• POST → Create data

• PUT/PATCH → Update data

• DELETE → Remove data

Data is sent and received as JSON.

Basic requirements:

• An API token for authentication

• The campaign ID (each campaign has its own data model)

• Valid field slugs and correct payload structure

• HTTPS requests

The API returns structured responses that match your campaign configuration.

Common integration scenarios

1. Website → Hubhus

Send website form submissions directly into a Hubhus campaign.

2. CRM or ERP → Hubhus

Synchronize leads or customer data from another system.

3. Hubhus → external reporting

Export leads, statuses, events, or performance metrics into BI dashboards.

4. Lead distribution

Send new leads to partners, subcontractors, regional teams, or external apps.

5. Custom booking or onboarding flows

Build your own customer-facing flows and submit results into Hubhus via the API.

6. File uploads

Upload documents, images, or PDFs through integrations.

API vs. Webhooks vs. Zapier

Hubhus API

• Best for custom systems, backend integrations, mobile apps, and automations

• Full control of data

• Requires development skills

Webhooks

• Hubhus pushes data out to your system in real time

• Great for instant reactions

• Best for integrations that listen for:

  • new files

  • new bookings

  • status updates

  • field changes

• Often used together with API calls

Zapier or Make

• No-code integration option

• Works well for simple flows and popular apps

• Good for teams without developers

• Not recommended for heavy or complex data flows

Summary:

• Use API when you need full control.

• Use webhooks when you need real-time triggers.

• Use Zapier or make or no-code tools for simple, lightweight integrations.

Getting started with the API

To begin using the Hubhus API, follow these basic steps:

1. Locate your API token

Found under Account → API documentation → New API documentation → API Tokens.

2. Identify your campaign ID

The campaign ID appears in the URL when you have the campaign open.

3. Review field API names

All payloads must use the correct field slugs from your campaign.
(These are shown directly in the API documentation.)

4. Open the official API documentation

The public API page shows:

• All fields and select options

• Required/optional parameters

• JSON schemas

• Example payloads

➡️ Use this as the primary reference when building requests.

5. Test with a tool like Postman

Verify your:

• Token

• Campaign ID

• Basic GET/POST requests

6. Start with simple operations

Recommended first calls:

• Create a lead

• Update a field

• Fetch a list of leads

Once these work, you can expand to full workflows and integrations.

Learning outcome

After reading this, you should understand:

• What the Hubhus API is

• How REST API communication works

• When to use API vs. webhooks vs. Zapier

• Common integration patterns

• How to get started with API requests

Related articles

    API setup and authentication

? Common searches

api setup • api integration • webhook setup • api authentication

? Also known as

integration • webhook • endpoint

Related articles

Building workflows in Hubhus
Understanding action listeners
What is automation in Hubhus?
How does the calendar system work?
Understanding booking forms