Skip to main content

Installing the SDK

1

Install the SDK

2

Initialize the Client

Initialization

The SDK accepts a token and optional configuration:

Config

debug
boolean
default:"false"
When true, enables request logging for debugging.

Quick Start

Once initialized, you can start using the SDK immediately:

Response Format

All API responses are normalized to a single shape:
  • Top level: method-specific fields (e.g. message_id, email_id, domains, metadata).
  • metadata: { id, timestamp, api_version, object } on every response.
Clean responses with metadata separate from the main data:

Errors

On API errors the SDK throws ContiguityError (subclass of Error) with message, status (HTTP status), and optional code.

Webhooks

To verify and parse webhook payloads, use contiguity.webhook.verify() and contiguity.webhook.parse(). See Webhooks for the full reference.