> ## 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

> Ocorre quando o status de entrega de um e-mail é atualizado e o status muda para `delivered` ou `failed`.

Use `email.delivery.updated` para manipular este evento em seu endpoint de webhook.

## Gatilhos

Ocorre quando o status de entrega de um e-mail é atualizado e o status muda para `delivered` ou `failed`.

Inscreva-se em `email.delivery.updated` quando você [configurar seu endpoint de webhook](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Sintaxe

A YCloud envia uma requisição HTTP `POST` para a URL de webhook configurada. O formato a seguir mostra uma variante do payload. Os valores entre colchetes angulares são marcadores de posição; seus tipos estão listados em **Parâmetros**. Campos opcionais e outras variantes estão descritos abaixo.

```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>"
  }
}
```

## Parâmetros

Valide o cabeçalho HTTP `YCloud-Signature` antes de processar o corpo JSON. Consulte [validação de assinatura](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Envelope do evento

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `id` | string | Sim | ID exclusivo para o evento. Comprimento mínimo: `6`. Comprimento máximo: `128`. |
| `type` | string | Sim | Sempre `email.delivery.updated`. |
| `apiVersion` | string | Sim | A versão da API usada para renderizar este evento. |
| `createTime` | string (date-time) | Sim | O momento em que este evento foi criado, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Ex.: `2022-06-01T12:00:00.000Z`. |

### Payload do evento

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `emailDelivery` | object | Não | Payload de `emailDelivery` específico do evento. |

Os quatro campos comuns do envelope são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objetos, **Obrigatório** se aplica quando o objeto pai estiver presente. Campos opcionais podem ser omitidos; um exemplo não torna um campo obrigatório.

#### emailDelivery

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `emailId` | string | Sim | ID exclusivo para o e-mail relacionado enviado anteriormente.Comprimento mínimo: `6`. Comprimento máximo: `128`. |
| `recipientAddress` | string | Sim | Um endereço de e-mail do destinatário. |
| `status` | string | Não | Status de entrega do e-mail para o endereço de destinatário específico.<ul><li>`sending`: A solicitação de mensagem foi aceita pelo nosso sistema.</li><li>`failed`: Falha ao enviar a mensagem do nosso sistema.</li><li>`sent`: A mensagem foi enviada pelo nosso sistema.</li><li>`delivered`: Nosso sistema recebeu um comprovante de entrega indicando que a mensagem foi entregue.</li><li>`undelivered`: Nosso sistema recebeu um comprovante de entrega indicando que a mensagem não foi entregue.</li></ul> |
| `errorCode` | string | Não | Código de erro quando o e-mail não puder ser entregue. |
| `errorMessage` | string | Não | Mensagem de erro quando o e-mail não puder ser entregue. |
| `externalId` | string | Não | O `externalId` que você definiu ao enviar o e-mail. |
| `bizType` | string | Não | Pode estar vazio ou ser um de `email` ou `verify`. O padrão é `email`.<ul><li>`email`: Indica que a mensagem foi enviada pelo produto **Email**.</li><li>`verify`: Indica que a mensagem foi enviada pelo produto **Verify**.</li></ul> |
| `verificationId` | string | Não | O ID de verificação. Incluído somente quando `bizType` for `verify`. |

## Exemplo

O JSON a seguir é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos.

```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"
  }
}
```

Após verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta `2xx`. Processe tarefas lentas de forma assíncrona.

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

Para orientações detalhadas sobre cenários, consulte [exemplos anotados](https://docs.ycloud.com/pt/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.