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

# Lemlist: Add Webhook

> Create a Lemlist webhook that posts campaign events, such as replies or opens, to your URL. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Create a Lemlist webhook that posts campaign events, such as replies or opens, to your URL.

> [!NOTE]
>
> Tool ID: `lemlist_add_webhook`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'lemlist_add_webhook',
  {
    "target_url": "https://example.com/resource"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute lemlist_add_webhook --input '{
  "target_url": "https://example.com/resource"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "id": "id_123",
    "target_url": "https://example.com"
  }
}
```

Use `deepline describe lemlist_add_webhook --json` for the latest machine-readable contract.

## Input reference

Create a Lemlist webhook.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.target_url` | `string` | Yes | — | HTTPS URL to receive POST callbacks Format: `uri`. Minimum length: 1. |
| `payload.type` | `"emailsSent" \| "emailsOpened" \| "emailsClicked" \| "emailsReplied" \| "emailsBounced" \| "emailsUnsubscribed" \| "emailsFailed" \| "emailsInterested" \| "emailsNotInterested" \| "linkedinSent" \| "linkedinOpened" \| "linkedinReplied" \| "linkedinInterested" \| "linkedinNotInterested" \| "apiDone" \| "aircallCreated" \| "aircallCompleted" \| "aircallNotAnswered" \| "manualDone" \| "contactedByVisitor"` | No | — | Event type to listen for (omit for all events) Allowed: `emailsSent`, `emailsOpened`, `emailsClicked`, `emailsReplied`, `emailsBounced`, `emailsUnsubscribed`, `emailsFailed`, `emailsInterested`, `emailsNotInterested`, `linkedinSent`, `linkedinOpened`, `linkedinReplied`, `linkedinInterested`, `linkedinNotInterested`, `apiDone`, `aircallCreated`, `aircallCompleted`, `aircallNotAnswered`, `manualDone`, `contactedByVisitor`. |
| `payload.campaign_id` | `string` | No | — | Scope webhook to specific campaign |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Create a Lemlist webhook.",
    "properties": {
      "target_url": {
        "type": "string",
        "description": "HTTPS URL to receive POST callbacks",
        "minLength": 1,
        "format": "uri"
      },
      "type": {
        "type": "string",
        "description": "Event type to listen for (omit for all events)",
        "enum": [
          "emailsSent",
          "emailsOpened",
          "emailsClicked",
          "emailsReplied",
          "emailsBounced",
          "emailsUnsubscribed",
          "emailsFailed",
          "emailsInterested",
          "emailsNotInterested",
          "linkedinSent",
          "linkedinOpened",
          "linkedinReplied",
          "linkedinInterested",
          "linkedinNotInterested",
          "apiDone",
          "aircallCreated",
          "aircallCompleted",
          "aircallNotAnswered",
          "manualDone",
          "contactedByVisitor"
        ]
      },
      "campaign_id": {
        "type": "string",
        "description": "Scope webhook to specific campaign"
      }
    },
    "required": [
      "target_url"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `string` | Yes | — | — |
| `result.data.target_url` | `string` | Yes | — | — |
| `result.data.type` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "id": {
            "type": "string"
          },
          "target_url": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "target_url"
        ],
        "additionalProperties": true
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Lemlist provider guide](https://deepline.com/docs/providers/lemlist/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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