Support

Frequently asked questions

1Pontos principais

Nos conheça melhor

2Características das correspondências

Detalhes da nossa produção

3Processo de envio

Como os pedidos são processados

4Requisitos mínimos e uso de dados

Adequados a LGPD

5Adicionando créditos a minha conta

Passo a passo de como adicionar créditos em sua conta

6Criando uma conta e solicitando novos pedidos

Crie uma conta e envie cartas

7WhatsApp Registrado

Envio de mensagens via WhatsApp oficial com validade jurídica

8E-mail Registrado

Envio de e-mail com validade jurídica e carimbo ICP-Brasil

Webhooks

Visão geral

Como os webhooks funcionam e como configurá-los na sua conta.

Webhooks permitem que a Escrybe notifique sua aplicação em tempo real quando eventos ocorrem nos seus pedidos. Ao invés de consultar nossa API periodicamente, você cadastra uma URL e passamos a enviar um POST com JSON sempre que um evento relevante acontece.

Configure seus webhooks em Opções → Webhooks. Cada webhook pode subscrever um ou mais tipos de evento e, opcionalmente, ter um segredo para validação de assinatura.

Cabeçalhos enviados em toda requisição

Header	Valor
`Content-Type`	`application/json`
`User-Agent`	`Escrybe-Webhooks/1.0`
`X-Webhook-Event`	Tipo do evento (ex: `order.created`)
`X-Webhook-Delivery`	ID único da entrega
`X-Webhook-Timestamp`	Horário do envio (servidor)
`X-Webhook-Signature`	`sha256=<hmac>` — somente se segredo configurado

A assinatura é calculada com HMAC-SHA256 sobre o corpo JSON completo usando o segredo que você definiu no cadastro do webhook. Sua aplicação deve responder com HTTP 2xx para confirmar o recebimento — caso contrário a entrega será tentada novamente com backoff exponencial (5, 10, 20 min) até 3 tentativas.

Eventos disponíveis

Disparado quando um novo pedido é criado. Disponível para cartas e e-mails registrados.

order.created

Carta

{
  "event": "order.created",
  "timestamp": "2026-03-31 12:00:00",
  "webhook_id": 42,
  "delivery_id": 99,
  "data": {
    "id": "XXXX",
    "type": "letter",
    "status": 0,
    "shipType": "...",
    "numPages": 1,
    "value": 12.50,
    "created_at": "2026-03-31 10:00:00",
    "paymentMethod": "...",
    "recipient": {
      "name": "...", "addr1": "...", "addr2": "...",
      "city": "...", "state": "...", "zip": "...", "country": "..."
    },
    "sender": {
      "name_sender": "...", "addr1_sender": "...", "addr2_sender": "...",
      "city_sender": "...", "state_sender": "...", "zip_sender": "...", "country_sender": "..."
    }
  }
}

E-mail registrado

{
  "event": "order.created",
  "timestamp": "2026-03-31 12:00:00",
  "webhook_id": 42,
  "delivery_id": 99,
  "data": {
    "id": "EXXXX",
    "type": "email",
    "status": 0,
    "recipient": { "name": "...", "email": "..." },
    "sender": {
      "name_sender": "...",
      "email_sender": "[email protected]",
      "email_replyTo": "[email protected]"
    },
    "subject": "...",
    "value": 5.00,
    "created_at": "2026-03-31 10:00:00",
    "paymentMethod": "..."
  }
}

Disparado quando o status de um pedido muda. Disponível para cartas e e-mails registrados.

Códigos de estado de cartas/telegramas

Status	Significado
`0`	Processando
`1`	Em produção
`2`	Créditos insuficientes
`3`	Impresso
`4`	Enviado
`5`	Cancelado

Códigos de estado de e-mails registrados

Status	Significado
`0`	Processando
`1`	Aguardando envio
`2`	Créditos insuficientes
`3`	Enviado
`4`	Cancelado
`5`	Falha

order.status_updated

Carta

{
  "event": "order.status_updated",
  "timestamp": "2026-03-31 12:00:00",
  "webhook_id": 42,
  "delivery_id": 99,
  "data": {
    "id": "XXXX",
    "type": "letter",
    "status": { "old": 0, "new": 1 },
    "updated_at": "2026-03-31 11:00:00",
    "tracking": "AA123456789BR"
  }
}

E-mail registrado

{
  "event": "order.status_updated",
  "timestamp": "2026-03-31 12:00:00",
  "webhook_id": 42,
  "delivery_id": 99,
  "data": {
    "id": "EXXXX",
    "type": "email",
    "status": { "old": 0, "new": 1 },
    "updated_at": "2026-03-31 11:00:00",
    "opened": false,
    "date_opened": null
  }
}

Disparado quando há atualização de rastreamento Correios. Disponível somente para cartas.

O campo event_detail_type indica o que mudou:

new_tracking_code — código de rastreio atribuído
new_tracking_record — novo evento de rastreamento

tracking.updated

{
  "event": "tracking.updated",
  "event_detail_type": "new_tracking_record",
  "timestamp": "2026-03-31 12:00:00",
  "webhook_id": 42,
  "delivery_id": 99,
  "data": {
    "id": "XXXX",
    "type": "letter",
    "tracking_code": "AA123456789BR",
    "tracking_records": [ { "...": "objeto de evento Correios" } ],
    "status_delivery": "...",
    "updated_at": "2026-03-31 11:30:00"
  }
}

Disparado quando um Aviso de Recebimento (AR/RR) é adicionado a uma carta. Disponível somente para cartas.

O campo rr_type indica a origem do arquivo:

rr_electronic — obtido automaticamente via API dos Correios
rr — digitalizado e inserido manualmente

O campo file.base64 contém o arquivo (PDF ou imagem) codificado em Base64.

rr.created

{
  "event": "rr.created",
  "timestamp": "2026-03-31 12:00:00",
  "webhook_id": 42,
  "delivery_id": 99,
  "data": {
    "id": "XXXX",
    "type": "letter",
    "rr_type": "rr_electronic",
    "tracking_code": "AA123456789BR",
    "file": {
      "name": "XXXX_AR.pdf",
      "base64": "<base64>"
    }
  }
}

Contact

Dúvidas, problemas e sugestões

Se você tem uma sugestão de nova funcionalidade, envie um e-mail com a sua ideia!

Se você enfrenta algum problema no uso na plataforma que não foi resolvido nessa página de suporte, entre em contato através do e-mail [email protected] ou pelo WhatsApp (14) 3418-0638