API & Integrations

Overview

The API & Integrations page allows you to create and manage API keys used to authenticate applications and services with the Webbula API. In addition you can run Single Record as well as Batch files from this page. 

API keys provide secure access to your account and can be restricted to specific IP address ranges for additional security.

Use this page to create new API credentials, review existing keys, and manage access for your integrations. To access it please click on the API & Integrations bookmark on the left hand side of your screen.
 

Getting Started

At the top of the API & Integrations page, the Getting Started panel provides a quick overview of the three steps required to begin using the API:

1. Create a key – Generate an API key and set an IP allowlist.
2. Authenticate – Pass your token in the request header.
3. Make a call – Copy a starter snippet and send a record.

Select View API Documentation in the top right corner of this panel to open the full API reference, including endpoint details, request/response examples, and authentication requirements.

API Keys

The API Keys section is where you create, search, and manage the keys used to authenticate your integrations.

Creating an API Key

Select Create Key in the API Keys section to generate a new API key.
 

Once the Create Key button is selected you will be presented with this screen:
 

Complete the following fields:

1. User – Click the dropdown and select the user this API key will belong to.
2. Title (optional) – Enter a name for the key (e.g., "Production Key" or "Test Server") to help identify it later.
3. IP Addresses (optional) – Enter the IP address(es) allowed to use this key.
   • Separate multiple addresses with a comma or semicolon (e.g., 10.0.0.1, 10.0.0.20)
   • Use a hyphen for a range (e.g., 10.0.0.1-10.0.0.20)
   • CIDR notation is also accepted (e.g., 10.0.0.1/22)
   • To allow requests from any IP address, enter 0.0.0.0/0 (this is filled in by default)

Once the required fields are complete, click Create Key to generate the API key.

Searching API Keys

Use the search field to quickly locate an existing API key. The search checks all fields shown in the table, including title, user, key, and IP range.

This is especially useful if your organization manages multiple API integrations.

API Keys Table

The API Keys table lists all keys associated with your account.

Each entry includes:

If no API keys have been created, the table displays a message indicating that no results are available.

IP Range Restrictions

To improve security, API keys can be restricted to specific IP addresses or IP ranges.

When an IP range is configured:

• Requests originating from approved IP addresses are allowed.
• Requests from other IP addresses are denied.

Restricting API keys to trusted servers helps reduce the risk of unauthorized API access.

Best Practices

To help secure your account:

• Create a separate API key for each application or integration.
• Use descriptive titles to identify each key's purpose.
• Restrict API keys to trusted IP addresses whenever possible.
• Delete unused or outdated API keys.
• Review your API keys periodically to ensure only active integrations have access.

API Types

Zuvo Protect detects a wide range of threats including spam traps, bots, disposable emails, role accounts, inactive contacts, undeliverable emails, and other signals that can damage inbox placement or waste campaign budget. It runs in two modes; choose the one that fits your volume and latency needs.

• Single Record – Returns results in the function response. Useful for web forms and other applications where a single email address needs to be processed in real time.
• Batch – Submit a file with task/run, then poll for completion and download the results. Built for high-volume lists.

Select Get Started under either option to view setup instructions and code samples for that API type.

Related Pages

• API Documentation
• Integrations
• Credits & Billing
• Dashboard