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

# email.delivery.updated

> Происходит при обновлении статуса доставки электронного письма, когда статус изменяется на `delivered` или `failed`.

Используйте `email.delivery.updated` для обработки этого события на вашей конечной точке Webhook.

## Триггеры

Происходит при обновлении статуса доставки электронного письма, когда статус изменяется на `delivered` или `failed`.

Подпишитесь на `email.delivery.updated` при [настройке конечной точки Webhook](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Синтаксис

YCloud отправляет HTTP-запрос `POST` на настроенный вами URL-адрес Webhook. Ниже показан один из вариантов полезной нагрузки. Значения в угловых скобках являются заполнителями; их типы перечислены в разделе **Параметры**. Необязательные поля и другие варианты описаны ниже.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "<ID>",
  "type": "email.delivery.updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "emailDelivery": {
    "emailId": "<EMAIL_ID>",
    "recipientAddress": "<RECIPIENT_ADDRESS>",
    "status": "<STATUS>",
    "externalId": "<EXTERNAL_ID>"
  }
}
```

## Параметры

Проверьте HTTP-заголовок `YCloud-Signature` перед обработкой тела JSON. См. раздел [проверка подписи](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Конверт события

| Параметр | Тип | Обязательный | Описание |
| - | - | - | - |
| `id` | string | Да | Уникальный идентификатор события. Минимальная длина: `6`. Максимальная длина: `128`. |
| `type` | string | Да | Всегда `email.delivery.updated`. |
| `apiVersion` | string | Да | Версия API, используемая для формирования этого события. |
| `createTime` | string (date-time) | Да | Время создания этого события в формате [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Например, `2022-06-01T12:00:00.000Z`. |

### Полезная нагрузка события

| Параметр | Тип | Обязательный | Описание |
| - | - | - | - |
| `emailDelivery` | object | Нет | Полезная нагрузка `emailDelivery`, специфичная для события. |

Четыре общих поля конверта являются обязательными. Поля полезной нагрузки зависят от варианта события. В таблице каждого объекта статус **Обязательный** применяется, если присутствует родительский объект. Необязательные поля могут быть опущены; наличие поля в примере не делает его обязательным.

#### emailDelivery

| Параметр | Тип | Обязательный | Описание |
| - | - | - | - |
| `emailId` | string | Да | Уникальный идентификатор связанного электронного письма, отправленного вами ранее.Минимальная длина: `6`. Максимальная длина: `128`. |
| `recipientAddress` | string | Да | Адрес электронной почты получателя. |
| `status` | string | Нет | Статус доставки электронного письма на конкретный адрес получателя.<ul><li>`sending`: запрос на отправку принят нашей системой.</li><li>`failed`: не удалось отправить сообщение из нашей системы.</li><li>`sent`: сообщение отправлено из нашей системы.</li><li>`delivered`: наша система получила подтверждение о доставке, указывающее, что сообщение доставлено.</li><li>`undelivered`: наша система получила отчет о доставке, указывающий, что сообщение не доставлено.</li></ul> |
| `errorCode` | string | Нет | Код ошибки в случае невозможности доставить электронное письмо. |
| `errorMessage` | string | Нет | Сообщение об ошибке в случае невозможности доставить электронное письмо. |
| `externalId` | string | Нет | `externalId`, заданный вами при отправке электронного письма. |
| `bizType` | string | Нет | Может быть пустым или одним из следующих значений: `email` или `verify`. По умолчанию: `email`.<ul><li>`email`: указывает, что сообщение отправлено через продукт **Email**.</li><li>`verify`: указывает, что сообщение отправлено через продукт **Verify**.</li></ul> |
| `verificationId` | string | Нет | Идентификатор верификации. Включается только в том случае, если `bizType` имеет значение `verify`. |

## Пример

Следующий фрагмент JSON представляет собой тело, доставленное вашему получателю. Идентификаторы, номера телефонов и другие данные аккаунта приведены для наглядности.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "evt_example_email_delivery_updated",
  "type": "email.delivery.updated",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "emailDelivery": {
    "emailId": "email_12345678",
    "recipientAddress": "recipient@example.com",
    "status": "delivered",
    "externalId": "order_123"
  }
}
```

После проверки подписи и надежного сохранения события верните ответ `2xx`. Длительные операции обрабатывайте асинхронно.

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

Разбор сценариев см. в разделе [примеры с пояснениями](https://docs.ycloud.com/ru/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples).


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