Schemas
/
Webhook

API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Languages
Servers
Instantly API Server

https://api.instantly.ai/

Mock server

https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

API Key

Operations

Account Campaign Mapping

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns.

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

SuperSearch Enrichment

A SuperSearch enrichment that retrieves and enriches leads based on search filters

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Clause

A clause (filter or sort) that can be applied to variables in campaigns or lists

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Schemas

Audit Log

Audit log records for tracking system activities

idstring(uuid)read-onlyrequired
Example: "01234567-89ab-cdef-0123-456789abcdef"
timestampstring(date-time)read-onlyrequired

When the activity occurred

Example: "2025-09-13T12:09:51.583Z"
organization_idstring(uuid)read-onlyrequired

Organization ID associated with the activity

Example: "01234567-89ab-cdef-0123-456789abcdef"
activity_typenumberread-onlyrequired

Type of activity performed

Enum ValueDescription
1

User login

2

Lead deletion

3

Campaign deletion

4

Campaign launch

5

Campaign pause

6

Account addition

7

Account deletion

8

Lead moved

9

Lead added

10

Lead merged

Example: 1
ip_addressstringread-onlyrequired

IP address from which the activity was performed

Example: "127.0.0.1"
from_apibooleanread-onlyrequired

Whether the activity was performed via API

Example: false
user_agentnull or stringread-only

User agent of the client that performed the activity

Example: "Mozilla/5.0..."
user_idnull or string(uuid)read-only

ID of the user who performed the activity

Example: "01234567-89ab-cdef-0123-456789abcdef"
affected_countnull or numberread-only

Number of items affected by the activity

Example: 1
campaign_idnull or string(uuid)read-only

Associated campaign ID if applicable

Example: "01234567-89ab-cdef-0123-456789abcdef"
subsequence_idnull or string(uuid)read-only

Associated subsequence ID if applicable

Example: "01234567-89ab-cdef-0123-456789abcdef"
list_idnull or string(uuid)read-only

Associated list ID if applicable

Example: "01234567-89ab-cdef-0123-456789abcdef"
audit_metadataobjectread-only

Metadata about the audit log

user_namenull or stringread-only

Name of the user who performed the activity

Example: "John Doe"
{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "timestamp": "2025-09-13T12:09:51.583Z",
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "activity_type": 1,
  "user_agent": "Mozilla/5.0...",
  "user_id": "01234567-89ab-cdef-0123-456789abcdef",
  "ip_address": "127.0.0.1",
  "from_api": false,
  "affected_count": 1,
  "campaign_id": "01234567-89ab-cdef-0123-456789abcdef",
  "subsequence_id": "01234567-89ab-cdef-0123-456789abcdef",
  "list_id": "01234567-89ab-cdef-0123-456789abcdef",
  "audit_metadata": {},
  "user_name": "John Doe"
}

Webhook

A webhook subscription for receiving event notifications

idstring(uuid)read-onlyrequired

Unique identifier for the webhook (UUID)

Example: "019942fb-54ee-7bfd-bfb7-a34c7db86548"
organizationstring(uuid)read-onlyrequired

Organization (workspace) UUID that owns this webhook

Example: "019942fb-54ee-7bfd-bfb7-a34d01da586c"
target_hook_urlstring(uri)^https?://required

Target URL to send webhook payloads

Example: "https://webhook.site/unique-url"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the webhook was created

Example: "2025-09-13T12:09:51.598Z"
campaignnull or string(uuid)

Optional campaign UUID to filter events (null = all campaigns in workspace)

Example: "019942fb-54ee-7bfd-bfb7-a34efc4aebb3"
event_typenull or string

Type of event to trigger the webhook (null for custom label events)

Enum"email_sent""email_opened""email_link_clicked""reply_received""email_bounced""lead_unsubscribed""campaign_completed""account_error""lead_neutral""lead_interested"
Example: "email_sent"
custom_interest_valuenull or number

Custom interest value - corresponds to LeadLabel.interest_status (used for custom label events)

Example: 1
{
  "id": "019942fb-54ee-7bfd-bfb7-a34c7db86548",
  "organization": "019942fb-54ee-7bfd-bfb7-a34d01da586c",
  "campaign": "019942fb-54ee-7bfd-bfb7-a34efc4aebb3",
  "target_hook_url": "https://webhook.site/unique-url",
  "event_type": "email_sent",
  "custom_interest_value": 1,
  "timestamp_created": "2025-09-13T12:09:51.598Z"
}