> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Instantly webhooks

> Instantly incoming webhooks in Corsair: the event paths to subscribe to, the payload each event carries, and the response data.

The Instantly plugin handles incoming webhooks. Point your provider’s subscription URL at your Corsair HTTP handler (see [Overview](https://docs.corsair.dev/plugins/instantly/overview.md) for setup context and the exact URL shape).

> [!NOTE]
>
> **New to Corsair?** See [webhooks](https://docs.corsair.dev/concepts/webhooks.md) and [hooks](https://docs.corsair.dev/concepts/hooks.md).

## Webhook map

* `accounts`
  * `error` (`accounts.error`)
* `campaigns`
  * `completed` (`campaigns.completed`)
* `emails`
  * `autoReplyReceived` (`emails.autoReplyReceived`)
  * `bounced` (`emails.bounced`)
  * `linkClicked` (`emails.linkClicked`)
  * `opened` (`emails.opened`)
  * `replyReceived` (`emails.replyReceived`)
  * `sent` (`emails.sent`)
* `events`
  * `other` (`events.other`)
* `leads`
  * `closed` (`leads.closed`)
  * `interested` (`leads.interested`)
  * `meetingBooked` (`leads.meetingBooked`)
  * `meetingCompleted` (`leads.meetingCompleted`)
  * `neutral` (`leads.neutral`)
  * `noShow` (`leads.noShow`)
  * `notInterested` (`leads.notInterested`)
  * `outOfOffice` (`leads.outOfOffice`)
  * `unsubscribed` (`leads.unsubscribed`)
  * `wrongPerson` (`leads.wrongPerson`)

## HTTP handler setup

```ts app/api/webhook/route.ts theme={null}
import { processWebhook } from "corsair";
import { corsair } from "@/server/corsair";

export async function POST(request: Request) {
    const headers = Object.fromEntries(request.headers);
    // With multiTenancy, give each tenant its own URL (/api/webhook?tenantId=acme):
    // the query says whose account, secret and hooks handle the delivery.
    const query = Object.fromEntries(new URL(request.url).searchParams);
    // The raw text, not request.json(): signatures are checked over the exact bytes sent.
    const body = await request.text();
    const result = await processWebhook(corsair, headers, body, query);
    if (!result.plugin) {
        return Response.json({ success: false }, { status: 404 });
    }
    // A refusal (bad signature) carries no status and answers 400; a handler
    // that threw comes back with 500, so the sender retries it.
    const status =
        result.response?.success === false ? (result.response.statusCode ?? 400) : 200;
    return Response.json(result.response ?? { success: true }, {
        status,
        headers: result.responseHeaders,
    });
}
```

## Events

## Accounts

### Error

`accounts.error`

A sending account hit a connection or sending error

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `account_error` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: account_error,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        accounts: {
            error: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

## Campaigns

### Completed

`campaigns.completed`

A campaign finished every lead

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `campaign_completed` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: campaign_completed,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        campaigns: {
            completed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

## Emails

### Auto Reply Received

`emails.autoReplyReceived`

An auto-reply (such as out of office) arrived. Only all\_events webhooks get it: Instantly has no auto\_reply\_received subscription

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `auto_reply_received` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: auto_reply_received,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        emails: {
            autoReplyReceived: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Bounced

`emails.bounced`

An email bounced

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `email_bounced` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: email_bounced,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        emails: {
            bounced: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Link Clicked

`emails.linkClicked`

A lead clicked a tracked link

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `email_link_clicked \| link_clicked` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: email_link_clicked | link_clicked,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        emails: {
            linkClicked: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Opened

`emails.opened`

A lead opened an email

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `email_opened` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: email_opened,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        emails: {
            opened: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Reply Received

`emails.replyReceived`

A lead replied; carries reply\_text, reply\_html and email\_id (pass it to emails.reply as reply\_to\_uuid)

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `reply_received` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: reply_received,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        emails: {
            replyReceived: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Sent

`emails.sent`

A campaign email was sent

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `email_sent` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: email_sent,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        emails: {
            sent: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

## Events

### Other

`events.other`

An event with no dedicated handler: a custom lead label (event\_type is the label's name) or an event type Instantly added later. Instantly's payload does not say which, so check event\_type before acting

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `string` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: string,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        events: {
            other: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

## Leads

### Closed

`leads.closed`

A lead moved to Closed

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_closed` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_closed,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            closed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Interested

`leads.interested`

A lead was marked Interested

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_interested` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_interested,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            interested: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Meeting Booked

`leads.meetingBooked`

A lead moved to Meeting booked

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_meeting_booked` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_meeting_booked,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            meetingBooked: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Meeting Completed

`leads.meetingCompleted`

A lead moved to Meeting completed

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_meeting_completed` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_meeting_completed,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            meetingCompleted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Neutral

`leads.neutral`

A lead was marked Neutral

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_neutral` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_neutral,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            neutral: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### No Show

`leads.noShow`

A lead moved to No show

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_no_show` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_no_show,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            noShow: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Not Interested

`leads.notInterested`

A lead was marked Not interested

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_not_interested` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_not_interested,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            notInterested: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Out Of Office

`leads.outOfOffice`

A lead moved to Out of office

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_out_of_office` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_out_of_office,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            outOfOffice: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Unsubscribed

`leads.unsubscribed`

A lead unsubscribed

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_unsubscribed` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_unsubscribed,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            unsubscribed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***

### Wrong Person

`leads.wrongPerson`

A lead moved to Wrong person

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_type` | `lead_wrong_person` | Yes | — |
| `timestamp` | `string` | Yes | When the event happened (ISO 8601) |
| `workspace` | `string` | Yes | Workspace ID |
| `campaign_id` | `string \| null` | No | — |
| `campaign_name` | `string \| null` | No | — |
| `lead_email` | `string \| null` | No | — |
| `email_account` | `string \| null` | No | Sending account involved |
| `step` | `number \| string \| null` | No | Sequence step, from 1 |
| `variant` | `number \| string \| null` | No | Step variant, from 1 |
| `is_first` | `boolean \| null` | No | First event of this type for the lead |
| `email_id` | `string \| null` | No | Email ID; pass as reply\_to\_uuid to emails.reply to answer it |
| `email_subject` | `string \| null` | No | — |
| `email_text` | `string \| null` | No | — |
| `email_html` | `string \| null` | No | — |
| `unibox_url` | `string \| null` | No | — |
| `reply_subject` | `string \| null` | No | — |
| `reply_text_snippet` | `string \| null` | No | — |
| `reply_text` | `string \| null` | No | — |
| `reply_html` | `string \| null` | No | — |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   event_type: lead_wrong_person,
>   timestamp: string,
>   workspace: string,
>   campaign_id?: string | null,
>   campaign_name?: string | null,
>   lead_email?: string | null,
>   email_account?: string | null,
>   step?: number | string | null,
>   variant?: number | string | null,
>   is_first?: boolean | null,
>   email_id?: string | null,
>   email_subject?: string | null,
>   email_text?: string | null,
>   email_html?: string | null,
>   unibox_url?: string | null,
>   reply_subject?: string | null,
>   reply_text_snippet?: string | null,
>   reply_text?: string | null,
>   reply_html?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
instantly({
    webhookHooks: {
        leads: {
            wrongPerson: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.