Platform & Developer
/ api-webhooks

API & Webhooks

Programmatic access and event-driven integration.

Overview

A REST API and webhook system to read/write contacts, opportunities, appointments, messages, and more, and to receive real-time events. Used to sync with external systems and build custom automations.

What it's for

Integrate the platform with external CRMs, data warehouses, and custom tools.

Capabilities

REST API

CRUD for contacts, opportunities, appointments, messages, and more.

Webhooks (outbound)

Receive events (contact created, form submitted, payment paid) at your endpoint.

OAuth / API keys

Authenticate per sub-account with scoped tokens.

Inbound webhooks

Trigger workflows from external events via webhook trigger.

Rate limits

Documented per-plan rate limits on API calls.

Use cases

Sync to external CRM

Use outbound webhooks to push contact/opportunity changes to an external system in real time.

Custom dashboard

Pull data via the API into a data warehouse for custom BI.

AI prompt patterns

Copyable templates for prompting an AI agent about this feature.

Plan an integration
Plan an integration between [external system] and the platform: which API endpoints, which webhook events, auth method, and error/retry handling.
Design a webhook receiver
Design a secure webhook receiver for [events]: signature verification, idempotency, retry/backoff, and what to do with each event type.

Integrations & connections

  • Workflows can call the API and send/receive webhooks
  • External systems sync contacts and objects via API

Gotchas & limits

Things an AI should not assume about this feature.

Webhook payloads are event-specific; verify the schema per event type.
Always verify webhook signatures to reject forged requests.
API rate limits return 429 — implement backoff, not retry storms.

Related features