> ## 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: Get Deliverability Alerts Alertid

> Get one Lemlist deliverability alert by its ID, with its metric, threshold and scope. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Get one Lemlist deliverability alert by its ID, with its metric, threshold and scope.

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

## 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_get_deliverability_alerts_alertid',
  {
    "alertId": "alert_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute lemlist_get_deliverability_alerts_alertid --input '{
  "alertId": "alert_123"
}' --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": "_123",
    "teamId": "team_123",
    "createdBy": "example"
  }
}
```

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

## Input reference

Get Deliverability Alert

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.alertId` | `string` | Yes | — | Unique alert configuration ID. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get Deliverability Alert",
    "properties": {
      "alertId": {
        "type": "string",
        "description": "Unique alert configuration ID."
      }
    },
    "required": [
      "alertId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A deliverability alert configuration. The alert is evaluated periodically against your warm-up or outreach metrics and triggers notifications through the configured channels (in-app, email, webhook, Slack) when the threshold is breached. |
| `result.data._id` | `string` | No | — | Unique alert configuration identifier (prefixed with `dac_`). |
| `result.data.teamId` | `string` | No | — | ID of the team that owns the alert. |
| `result.data.createdBy` | `string` | No | — | ID of the user who created the alert. |
| `result.data.createdAt` | `string` | No | — | Creation timestamp. Format: `date-time`. |
| `result.data.updatedAt` | `string` | No | — | Last update timestamp. Format: `date-time`. |
| `result.data.widget` | `"warmup" \| "outreach"` | No | — | Data source the alert evaluates. `warmup` checks lemwarm metrics. `outreach` checks campaign-sending metrics. Allowed: `warmup`, `outreach`. |
| `result.data.metric` | `"inboxRate" \| "spamRate" \| "score" \| "deliveryRate" \| "bounceRate"` | No | — | Metric being monitored. Valid combinations depend on `widget`: `warmup` supports `inboxRate`, `spamRate`, `score`. `outreach` supports `deliveryRate`, `bounceRate`. Allowed: `inboxRate`, `spamRate`, `score`, `deliveryRate`, `bounceRate`. |
| `result.data.severity` | `"warning" \| "critical"` | No | — | Alert severity. Allowed: `warning`, `critical`. |
| `result.data.scope` | `"global" \| "mailbox" \| "domain"` | No | — | Aggregation level the metric is computed at. `global` covers all of the workspace's mailboxes (warm-up only). `mailbox` evaluates each mailbox individually. `domain` groups mailboxes by their sending domain. Allowed: `global`, `mailbox`, `domain`. |
| `result.data.scopeEntities` | `array` | No | — | Restricts the alert to a subset of entities matching `scope`. When empty, all entities of that scope are checked. For `scope=mailbox`, each entry is a composite string `userId\|email\|mailboxId`. For `scope=domain`, each entry is a domain (e.g. `acme.com`). Ignored when `scope=global`. |
| `result.data.threshold` | `number` | No | — | Threshold value the metric is compared against (0–100, expressed as a percentage for rate metrics). Minimum: 0. Maximum: 100. |
| `result.data.comparisonOperator` | `"equal" \| "below" \| "above"` | No | — | How `threshold` is compared to the current value. `below` triggers when the value drops under the threshold. `above` triggers when it exceeds it. `equal` triggers on exact match. Allowed: `equal`, `below`, `above`. |
| `result.data.periodDays` | `integer` | No | — | Length of the evaluation window, in days (1–30). Minimum: 1. Maximum: 30. |
| `result.data.periodMode` | `"rolling" \| "consecutive"` | No | — | How the metric is computed over `periodDays`. `rolling` averages the metric across the window. `consecutive` requires the condition to hold on every one of the most recent `periodDays`. Allowed: `rolling`, `consecutive`. |
| `result.data.channelConfig` | `object` | No | — | Notification channels triggered when the alert fires. At least one channel must be enabled. If omitted on creation, defaults to `inapp` only. |
| `result.data.channelConfig.email` | `object` | No | — | — |
| `result.data.channelConfig.email.enabled` | `boolean` | No | — | — |
| `result.data.channelConfig.email.addresses` | `array` | No | — | Required when `email.enabled` is `true`. At least one valid address. |
| `result.data.channelConfig.inapp` | `object` | No | — | — |
| `result.data.channelConfig.inapp.enabled` | `boolean` | No | — | Show the alert in the lemlist app. |
| `result.data.channelConfig.webhook` | `object` | No | — | — |
| `result.data.channelConfig.webhook.enabled` | `boolean` | No | — | Send a webhook callback. Requires a webhook subscribed to the `deliverabilityAlertTriggered` event (see [Add Webhook](https://deepline.com/docs/api-reference/endpoints/webhooks/add-webhook)). |
| `result.data.channelConfig.slack` | `object` | No | — | — |
| `result.data.channelConfig.slack.enabled` | `boolean` | No | — | Send a Slack message. Requires a Slack integration to be connected on the team. |
| `result.data.enabled` | `boolean` | No | — | Whether the alert is currently active. Disabled alerts are not evaluated. |
| `result.data.lastCheckedAt` | `string` | No | — | Last time the alert was evaluated. Format: `date-time`. |
| `result.data.lastTriggeredAt` | `string` | No | — | Last time the alert fired. Format: `date-time`. |
| `result.data.recheckDelayHours` | `integer` | No | — | Cool-down between re-evaluations after the alert has triggered, in hours. Defaults to 12. |
| `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": "A deliverability alert configuration. The alert is evaluated periodically against your warm-up or outreach metrics and triggers notifications through the configured channels (in-app, email, webhook, Slack) when the threshold is breached.",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Unique alert configuration identifier (prefixed with `dac_`)."
          },
          "teamId": {
            "type": "string",
            "description": "ID of the team that owns the alert."
          },
          "createdBy": {
            "type": "string",
            "description": "ID of the user who created the alert."
          },
          "createdAt": {
            "type": "string",
            "description": "Creation timestamp.",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "description": "Last update timestamp.",
            "format": "date-time"
          },
          "widget": {
            "type": "string",
            "description": "Data source the alert evaluates. `warmup` checks lemwarm metrics; `outreach` checks campaign-sending metrics.",
            "enum": [
              "warmup",
              "outreach"
            ]
          },
          "metric": {
            "type": "string",
            "description": "Metric being monitored. Valid combinations depend on `widget`: `warmup` supports `inboxRate`, `spamRate`, `score`; `outreach` supports `deliveryRate`, `bounceRate`.",
            "enum": [
              "inboxRate",
              "spamRate",
              "score",
              "deliveryRate",
              "bounceRate"
            ]
          },
          "severity": {
            "type": "string",
            "description": "Alert severity.",
            "enum": [
              "warning",
              "critical"
            ]
          },
          "scope": {
            "type": "string",
            "description": "Aggregation level the metric is computed at. `global` covers all of the workspace's mailboxes (warm-up only); `mailbox` evaluates each mailbox individually; `domain` groups mailboxes by their sending domain.",
            "enum": [
              "global",
              "mailbox",
              "domain"
            ]
          },
          "scopeEntities": {
            "type": "array",
            "description": "Restricts the alert to a subset of entities matching `scope`. When empty, all entities of that scope are checked. For `scope=mailbox`, each entry is a composite string `userId|email|mailboxId`. For `scope=domain`, each entry is a domain (e.g. `acme.com`). Ignored when `scope=global`.",
            "items": {
              "type": "string"
            }
          },
          "threshold": {
            "type": "number",
            "description": "Threshold value the metric is compared against (0–100, expressed as a percentage for rate metrics).",
            "minimum": 0,
            "maximum": 100
          },
          "comparisonOperator": {
            "type": "string",
            "description": "How `threshold` is compared to the current value. `below` triggers when the value drops under the threshold; `above` triggers when it exceeds it; `equal` triggers on exact match.",
            "enum": [
              "equal",
              "below",
              "above"
            ]
          },
          "periodDays": {
            "type": "integer",
            "description": "Length of the evaluation window, in days (1–30).",
            "minimum": 1,
            "maximum": 30
          },
          "periodMode": {
            "type": "string",
            "description": "How the metric is computed over `periodDays`. `rolling` averages the metric across the window; `consecutive` requires the condition to hold on every one of the most recent `periodDays`.",
            "enum": [
              "rolling",
              "consecutive"
            ]
          },
          "channelConfig": {
            "type": "object",
            "description": "Notification channels triggered when the alert fires. At least one channel must be enabled. If omitted on creation, defaults to `inapp` only.",
            "properties": {
              "email": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "addresses": {
                    "type": "array",
                    "description": "Required when `email.enabled` is `true`. At least one valid address.",
                    "items": {
                      "type": "string",
                      "format": "email"
                    }
                  }
                },
                "additionalProperties": false
              },
              "inapp": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean",
                    "description": "Show the alert in the lemlist app."
                  }
                },
                "additionalProperties": false
              },
              "webhook": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean",
                    "description": "Send a webhook callback. Requires a webhook subscribed to the `deliverabilityAlertTriggered` event (see [Add Webhook](/api-reference/endpoints/webhooks/add-webhook))."
                  }
                },
                "additionalProperties": false
              },
              "slack": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean",
                    "description": "Send a Slack message. Requires a Slack integration to be connected on the team."
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          },
          "enabled": {
            "type": "boolean",
            "description": "Whether the alert is currently active. Disabled alerts are not evaluated."
          },
          "lastCheckedAt": {
            "type": "string",
            "description": "Last time the alert was evaluated.",
            "format": "date-time"
          },
          "lastTriggeredAt": {
            "type": "string",
            "description": "Last time the alert fired.",
            "format": "date-time"
          },
          "recheckDelayHours": {
            "type": "integer",
            "description": "Cool-down between re-evaluations after the alert has triggered, in hours. Defaults to 12."
          }
        },
        "additionalProperties": false
      },
      "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.