Skip to main content

Guides Overview

Welcome to the CleverReach Guides! Here you will find in-depth tutorials, best practices, and architectural explanations to help you integrate effectively with our API. Whether you are building a custom CRM synchronization, creating sign-up forms, or listening to real-time events, these guides will walk you through the implementation.

We highly recommend reviewing these concepts before diving straight into the raw API reference.

Available Guides​

Explore the following topics to get started:

Authentication​

Learn the fundamentals of securely connecting your application to the CleverReach API. Understand the OAuth 2.0 flow, how to handle access tokens, and best practices for securely storing your credentials.

Double Opt-In (DOI)​

Understand the legal and technical requirements for managing subscriber consent. This guide shows you how to properly add an inactive receiver, trigger the DOI email using CleverReach templates, and attach legal audit trails (doidata) to your subscribers.

Webhooks​

Move from constant polling to an event-driven architecture. Discover how to configure webhooks, verify HMAC payload signatures, and handle instant account notifications like new subscriptions, unsubscriptions, and profile updates.

MCP Server: AI Integrations​

Connect CleverReach directly to AI assistants like Claude, Cursor, and Gemini via the Model Context Protocol (MCP). Learn how to securely execute API tasks using natural language prompts within your AI workspace.

PHP SDK​

Get started with the official lightweight PHP SDK. Discover how to work with strongly typed services, automatically handle HTTP clients, and securely implement the CleverReach REST API in your PHP ecosystem.

Best Practices​

As you build with the CleverReach API, keep these general principles in mind:

  • Respect Rate Limits: While our API is robust, ensure your integration queues or batches large data syncs rather than executing thousands of concurrent real-time requests.
  • Always use Double Opt-In: The POST /forms.json/{id}/send/activate endpoint is your best friend. Directly activating unchecked emails can severely harm your deliverability.
  • Embrace Webhooks: If you need to know when an email bounces or a user unsubscribes, use Webhooks instead of running cron jobs that pull list changes every 5 minutes.