Suporte

Perguntas frequentes

1 Pontos principais

Nos conheça melhor

O que é a Escrybe?

Escrybe é uma plataforma completa para envio de correspondências físicas (cartas, telegramas, Sedex), e-mail registrado e WhatsApp registrado pela internet. Oferece validade jurídica em diversas modalidades por meio de carimbos do tempo ICP-Brasil e integração com os Correios.

Como fazer o envio de cartas?

Através do site você pode solicitar o envio de: cartas e telegramas, e-mail registrado e WhatsApp registrado. Para quem possui um site, sistema ou aplicativo, existe a API Escrybe para integração. Veja a documentação em escrybe.readme.io.

Como as cartas chegam até os destinatários?

Utilizamos os serviços dos Correios para fazer a logística de entrega das correspondências.

Do que eu preciso para fazer o envio de cartas?

Você precisará fazer um cadastro em nosso site (escrybe.com.br/cadastro), adicionar créditos a sua conta, fornecer os dados de remetente e destinatário e um arquivo PDF com o conteúdo da sua carta.

2 Características das correspondências

Detalhes da nossa produção

Quais são os formatos de papel e envelopes?

As cartas são impressas em papel tamanho A4 (210 x 297 mm) 75gm/m² e inseridas em envelopes de acordo com a quantidade de páginas. Em correspondências de até 15 páginas, é utilizado envelope ofício padrão com janela, as folhas são dobradas em 3 partes. Acima de 15 páginas, são inseridas sem dobras em envelopes tipo saco. As folhas não são grampeadas.

Os telegramas são impressos pela agência dos Correios mais próxima do endereço do destinatário.

Limites de páginas

As cartas devem ter no mínimo uma página e no máximo 100 páginas.

Os telegramas devem ter no mínimo uma página e no máximo 10 páginas. É considerado uma página a cada 2.245 caracteres.

Tipo de papel

As cartas impressas pela Escrybe são compostas somente de papel de reflorestamento ou reciclado.

Quais são as modalidades de envio disponíveis?

Carta simples: modo mais econômico.
Carta registrada: possui código de rastreio para saber quando a carta foi entregue ou se ela foi devolvida.
Carta registrada com AR: além do código de rastreio, esta modalidade possui também o aviso de recebimento, que é um documento assinado pelo destinatário e enviado de volta para o remetente, comprovando a entrega da correspondência.
Entrega em mãos (ou Mão Própria - MP): este é um serviço adicional que pode ser utilizado junto das modalidades "Registrada" e "Registrada com AR". Com este serviço, a correspondência só será entregue para o destinatário cujo nome está descrito no campo "Nome do destinatário", não podendo ser assinado por terceiros.
Telegrama: forma mais rápida de envio, em alguns casos entregue até no mesmo dia da postagem. Ideal para mensagens mais curtas e urgentes. Possui a opção 'cópia ao remetente' onde a pessoa que envia mensagem recebe uma cópia idêntica da mensagem enviada ao destinatário. A opção 'confirmação de entrega' entrega ao remetente um comprovante assinado pelo destinatário. O telegrama é ideal para provar que uma mensagem simples foi entregue. Outra opção é a telegrama 'pré-datado' onde se define uma data exata em que a mensagem será entregue.
Sedex: envio expresso com rastreio e entrega mais rápida. Conteúdo personalizado em PDF. Entrega em mãos opcional.
Sedex + AR: como o Sedex, mas com aviso de recebimento, conferindo validade jurídica à entrega.
Mala Direta: envio em volume para múltiplos destinatários.
eCarta (Simples, Registrada, Registrada + AR): correspondência eletrônica entregue pelos Correios em formato digital, com as mesmas garantias das cartas físicas.
Preços de cada modalidade

Como preparar o conteúdo da minha carta?

O conteúdo da sua carta deve ser enviado em arquivo formato PDF.

Crie seu conteúdo em qualquer editor de texto ou imagem e exporte-o para o formato PDF. O tamanho da folha deve ser A4. Se seu arquivo possui folhas de tamanhos que não sejam A4, o conteúdo será enquadrado nesse tamanho automaticamente pelo nosso sistema para impressão.

É importante observar que a impressão possui bordas de até 1cm em todos os lados do papel, por isso recomendamos que o conteúdo da carta não possua fundo colorido (chapado), pois irá ressaltar a existência da borda branca.

Como preparar o conteúdo do meu telegrama?

Caso opte pela modalidade de envio Telegrama, o conteúdo deve ser digitado ou "colado" no campo Mensagem durante o envio.

O texto não deve conter caracteres especiais nem emojis. Dica: substitua emojis por símbolos alfanuméricos como :) ou :-P.

O que é Virtual Box e como utilizar?

A Escrybe disponibiliza o serviço de caixa de correspondências virtual (Virtual Box) para clientes que não possuem endereço no Brasil ou que preferem que nós façamos o gerenciamento de sua correspondência.

Para correspondências enviadas utilizando o Virtual Box, o endereço da Escrybe será utilizado nos campos de endereço do remetente e assim nós ficaremos responsáveis por informar que a correspondência foi devolvida e receber, digitalizar e reencaminhar avisos de recebimento.

Este é um serviço opcional cobrado a parte e que ainda está em fase de testes e adaptação.

3 Processo de envio

Como os pedidos são processados

Quais são as etapas de envio de correspondências?

São 4 etapas:

1ª - criação da solicitação: após criar o pedido no sistema, seu pedido será inserido com o estado "Processando". Neste momento, o sistema analisará sua carta e se você possui créditos suficientes em sua conta.
2ª - análise de créditos: havendo créditos na conta, o pedido será alterado para o estado "Em produção", onde será impresso e envelopado em nossa central de envios. Caso não haja saldo em sua conta, o estado será alterado para "Créditos insuficientes". Neste caso, o sistema fará a verificação novamente de tempos em tempos até existirem créditos suficientes e mudará o estado para "Em produção" automaticamente. Você pode alterar este comportamento na sua página de configurações (escrybe.com.br/config) para que pedidos no estado "Créditos insuficientes" só sejam processados manualmente.
3ª - impressão (para cartas): o seu pedido será então impresso, etiquetado e envelopado pela equipe Escrybe e o pedido terá seu estado alterado para "Impresso".

ou

3ª - integração com Correios (para telegramas): a plataforma Escrybe irá inserir o pedido do telegrama no sistema dos Correios de forma automática.
4ª - postagem: após a produção, seu pedido será enviado para postagem nos Correios e mudará para o estado para "Postado".
5ª - código de rastreio: se o pedido foi enviado com modalidade "Carta registrada" ou "Carta registrada com AR" ou "Telegrama", será informado o código de rastreio que pode ser consultado na página Pedidos (escrybe.com.br/pedidos).

Na modalidade "Telegrama" o código de rastreio será informado no mesmo dia da postagem. Nas outras modalidades pode demorar até 24h.

O que acontece se uma carta não for entregue ao destinatário?

A correspondência será devolvida ao remetente informado na criação do pedido. Não nos responsabilizamos por devoluções.

Onde consultar o rastreio das cartas e telegramas?

O código de rastreio está disponível na página Pedidos (escrybe.com.br/pedidos), nas correspondências enviadas como Carta Registrada, Carta Registrada com AR, Sedex, Sedex + AR ou Telegrama. O código pode demorar até 24h para aparecer (exceto Telegrama, que geralmente é informado no mesmo dia). Você também pode rastrear diretamente no site dos Correios. Configure notificações de atualização em escrybe.com.br/config.

4 Requisitos mínimos e uso de dados

Adequados a LGPD

Requisitos mínimos

O serviço pode ser utilizado a partir de qualquer computador, celular ou tablet que utilize os navegadores mais modernos, recomendamos o uso do Google Chrome ou Mozilla Firefox.

Dados necessários

Para criar um cadastro na plataforma Escrybe, será necessário apenas o nome e um e-mail válido. Após ter o cadastro ativo, será necessário completar seus dados para poder inserir créditos através de boleto bancário e cartão de crédito. O cadastro completo consiste em: nome completo (pessoas físicas) ou razão social (pessoas jurídicas), CPF ou CNPJ e endereço completo.

Uso de informações pessoais

O uso dos seus dados tem como propósito: registro dos métodos de pagamento, emissão de notas fiscais e controle interno. Seus dados nunca serão compartilhados sem seu consentimento e estão protegidos em sistema criptografado. Mais informações sobre como usamos seus dados podem ser encontrados em nossas políticas de privacidade (escrybe.com.br/politica-de-privacidade).

5 Adicionando créditos a minha conta

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

Quais são as formas de pagamento para adicionar créditos?

Você poderá adicionar créditos a sua conta utilizando PIX, boleto bancário, cartão de crédito ou se possuir um código de cupom fornecido pela Escrybe.

Onde posso pagar um boleto emitido pela Escrybe?

O boleto pode ser pago via internet banking, pelo aplicativo do seu banco, qualquer agência bancária, casa lotérica, ou parceiro bancário (consulte com seu banco quais são os parceiros). Você pode também utilizar os diversos aplicativos de pagamento disponíveis hoje no mercado.

Quais as bandeiras de cartão de crédito aceitas?

São aceitas as bandeiras Visa, Mastercard, American Express e Diners Club.

Como adicionar crédito a minha conta?

1º - faça login na plataforma Escrybe.
2º - caso não tenha preenchido seus dados completos ainda, acesse a página Minhas informações. Preencha seu nome completo ou razão social, CPF ou CNPJ e endereço completo.
3º - acesse a página Minha conta e escolha a forma de pagamento seguindo as instruções da página
Ao utilizar cartão de crédito, seu saldo será atualizado imediatamente ao ter a compra aprovada pela sua operadora. Para boletos bancários, o prazo de confirmação de pagamento geralmente leva de 24 a 48h úteis após o pagamento, podendo acontecer antes. Ao receber a confirmação de pagamento, o saldo será liberado na sua conta automaticamente. Os boletos emitidos podem ser consultados e baixados no final desta mesma página. O método de pagamento PIX ou QR CODE PIX disponibiliza seu crédito alguns minutos após o pagamento ser efetuado.

Extrato da conta

Também pela página Minha conta, é possível acessar um extrato detalhado da sua conta, onde serão exibidos todos os créditos adicionados e debitados. No final da página, escolha qual mês deseja visualizar.

O que é o pagamento por fatura?

Clientes com contrato corporativo podem usar a opção Faturar em vez de débito imediato em créditos. O valor é consolidado na fatura mensal e pago conforme condições do contrato. A opção aparece no envio quando seu contrato permite. Consulte a equipe comercial para viabilizar faturamento.

6 Criando uma conta e solicitando novos pedidos

Crie uma conta e envie cartas

Como fazer um cadastro na plataforma Escrybe?

1º - acesse a página Cadastro.
2º - preencha seu nome, e-mail e uma senha de sua escolha.
3º - acesse a mensagem enviada para seu e-mail e clique no link de ativação. Obs: caso não tenha recebido o e-mail, verifique sua caixa de spam. Se mesmo após 5 minutos não ter recebido nada, acesse a página Recuperar senha, preencha seu e-mail e você receberá outra mensagem para ativação. Caso o problema persista, entre em contato conosco.
4º - após clicar no link de ativação enviado por e-mail, seu cadastro estará ativo e finalizado.

Como solicitar um novo envio de correspondência?

1º - faça login na plataforma Escrybe.
2º - na página inicial, navegue até "Enviar nova carta" ou clique em Nova carta, E-mail Registrado ou WhatsApp Registrado no menu, conforme o tipo de envio.
3º - siga as instruções na tela (dados de destinatário, remetente, conteúdo e modalidade). Para cartas, envie PDF; para e-mail e WhatsApp, preencha os campos indicados.
4º - verifique o saldo em Minha Conta e, se desejar, altere configurações como processamento automático de pedidos com créditos insuficientes e notificações.

Como integrar minha aplicação à Escrybe via API?

A Escrybe oferece API REST para integração com sites, sistemas e aplicativos. É possível enviar cartas, e-mails registrados e mensagens WhatsApp de forma automatizada. A documentação está em escrybe.readme.io. A autenticação usa o securityToken do usuário (disponível em Minhas informações). Entre em contato para mais detalhes sobre planos e limites.

Como criar uma planilha para enviar a mesma carta para múltiplos destinatários?

Ao criar um novo envio, você deve digitar os dados de cada destinatário que irá receber a correspondência. Para facilitar este processo você pode utilizar uma planilha com os dados dos destinatários, dessa forma é muito mais fácil e rápido fazer disparos de grandes volumes.
Baixe uma planilha pronta, apague o conteúdo e insira seus próprios dados: Download planilha exemplo (Obs: ao abrir o arquivo de exemplo, clique no botão "Habilitar Edição", caso necessário.)

Se preferir, crie sua própria planilha seguindo os passos abaixo:

7 WhatsApp Registrado

Envio de mensagens via WhatsApp oficial com validade jurídica

É seguro enviar WhatsApp pela Escrybe?

Sim. Utilizamos a API oficial do WhatsApp Business (Meta) para envio das mensagens. A comunicação é criptografada de ponta a ponta, e os dados dos destinatários são processados conforme nossa política de privacidade e a LGPD.

O WhatsApp enviado pela Escrybe tem validade jurídica?

As notificações enviadas pela Escrybe via WhatsApp possuem validade jurídica porque cada etapa da comunicação — envio, entrega e leitura — é registrada por meio da API oficial da Meta (WhatsApp Cloud API) e autenticada com Carimbo do Tempo ICP-Brasil, emitido por uma Autoridade Certificadora credenciada pelo Instituto Nacional de Tecnologia da Informação (ITI). Isso significa que os logs de cada evento são submetidos a hash criptográfico e carimbados por uma entidade confiável e independente, comprovando com precisão a data e hora exatas em que a mensagem foi entregue e visualizada pelo destinatário — sem possibilidade de adulteração posterior. Esse mecanismo está amparado pelo Art. 10, §1º da Medida Provisória nº 2.200-2/2001, que confere presunção de autenticidade e integridade a documentos eletrônicos autenticados no âmbito da ICP-Brasil, e pela Resolução CNJ nº 354/2020, que reconhece o comprovante eletrônico de envio e recebimento com data e hora como prova válida de comunicação processual. O resultado é um laudo técnico auditável, aceito em juízo, que transforma cada notificação enviada pela plataforma em prova jurídica robusta.

Como funciona o fluxo de envio do WhatsApp?

O envio de WhatsApp na Escrybe segue estas etapas:

1ª - Criação do pedido: Ao criar o envio em Enviar WhatsApp Registrado, o pedido é registrado com status "Processando Pagamento".
2ª - Análise de pagamento: O sistema verifica créditos na conta (ou faturamento, se contratado). Com saldo suficiente, o valor é debitado e o pedido vai para a fila. Sem saldo, o status fica "Créditos insuficientes" — o sistema tenta processar novamente automaticamente quando houver créditos. Você pode desativar este comportamento em escrybe.com.br/config para processamento apenas manual.
3ª - Fila de envio: O pedido entra na fila (wa_outbox) com status "Na fila de envio" ou "Processando". Um cron executa a cada minuto e envia as mensagens via Meta/WhatsApp.
4ª - Envio e status: Após enviar, o status é atualizado conforme webhooks da Meta: "Enviado" (aceito na API), "Entregue" (dispositivo do destinatário) e "Lido" (visualizado).
5ª - Carimbos do tempo: Cada evento (enviado, entregue, lido) recebe um carimbo ICP-Brasil para comprovação jurídica.

Acompanhe seus pedidos em escrybe.com.br/pedidos-whatsapp.

O que são os modelos de WhatsApp e como usá-los?

Os modelos (templates) são mensagens padrão aprovadas pela Meta/WhatsApp. Cada modelo pertence a um número de envio (sistema ou seu próprio).

Regras principais:

Cada modelo precisa ser enviado ao Meta para aprovação — o prazo pode levar de horas a dias úteis.
Categorias: UTILITY (notificações, utilidade), MARKETING (promoções), AUTHENTICATION (códigos, autenticação).
Variáveis no texto: use {{1}}, {{2}}, etc. — elas são preenchidas no momento do envio.
Opcionalmente, o modelo pode ter cabeçalho (texto, imagem ou documento) e rodapé.

Gerencie seus modelos em Meus Modelos WhatsApp. Use o botão Sincronizar para atualizar o status (aprovado, pendente, rejeitado) com a Meta.

Como usar meu próprio número de WhatsApp?

O envio pelo seu próprio número está disponível para assinantes do plano Premium. Para configurar:

1º — Acesse Meus Números WhatsApp nas opções da conta.
2º — Clique em Adicionar Número e informe: nome, telefone de exibição, Phone Number ID, WABA ID e, se disponível, Access Token. Esses IDs são obtidos no Meta Business Suite / Developer Console da Meta.
3º — Vincule ou crie modelos em Meus Modelos WhatsApp associados a esse número. Cada modelo deve estar aprovado pela Meta.
4º — Ao enviar em Enviar WhatsApp Registrado, escolha a opção Meu número e selecione o número desejado.

Saiba mais sobre o plano Premium em (14) 3418-0638.

Como consultar pedidos e gerar relatório pericial?

Na página Meus Pedidos WhatsApp você pode:

Filtrar por status: Na fila, Processando, Enviado, Falhou, Cancelado.
Ver detalhes de cada pedido: destinatário, remetente, valor, histórico de eventos (enviado, entregue, lido) e conteúdo da mensagem.
Gerar Relatório Pericial: Disponível para pedidos com status Enviado, Entregue ou Lido. O relatório é um PDF contendo dados da mensagem, eventos, carimbos do tempo ICP-Brasil e demais informações técnicas para uso em juízo.

O botão Gerar Relatório Pericial aparece nos detalhes do pedido (clique no pedido para expandir) quando o envio chegou a pelo menos "Enviado". O arquivo pode ser baixado e utilizado como prova documental.

Quais aspectos legais garantem a validade do WhatsApp da Escrybe?

Três pilares garantem a validade jurídica:

API oficial Meta/WhatsApp: Os eventos (enviado, entregue, lido) vêm diretamente da API oficial, sem manipulação intermediária. Os payloads originais são armazenados e associados aos carimbos.
Carimbo do Tempo ICP-Brasil: Cada evento é submetido a hash criptográfico e carimbado por uma Autoridade Certificadora credenciada pelo ITI, comprovando data e hora com presunção de autenticidade e integridade, conforme Art. 10, §1º da MP nº 2.200-2/2001.
Resolução CNJ nº 354/2020: Reconhece comprovante eletrônico de envio e recebimento com data e hora como prova válida de comunicação processual.

O resultado é um laudo técnico auditável e aceito em juízo, adequado para notificações, citações e comunicações que exigem comprovação de entrega e visualização.

8 E-mail Registrado

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

O que é o E-mail Registrado?

O E-mail Registrado é um serviço eletrônico equivalente a uma Carta Registrada. Cada mensagem recebe carimbo do tempo ICP-Brasil, comprovando autoria, conteúdo e cronologia de envio, entrega e tomada de conhecimento. O remetente é notificado quando o destinatário lê a mensagem.

O E-mail Registrado tem validade jurídica?

Sim. O serviço utiliza carimbo do tempo emitido por Autoridade Certificadora credenciada pelo ITI (ICP-Brasil), amparado pelo Art. 10, §1º da MP nº 2.200-2/2001 e pela Resolução CNJ nº 354/2020. Os anexos enviados também recebem carimbo. O resultado é um relatório técnico aceito em juízo.

Como enviar um E-mail Registrado?

1º — Faça login e complete seu cadastro (nome, CPF/CNPJ, endereço).
2º — Acesse Enviar E-mail Registrado no menu.
3º — Preencha nome e e-mail do destinatário, nome do remetente e dados da mensagem (assunto, corpo). O campo "Responder para" usa automaticamente seu e-mail cadastrado.
4º — Opcionalmente, anexe um arquivo. Dica: para maior garantia jurídica, copie o conteúdo do anexo e cole também no corpo do e-mail.
5º — Escolha pagamento por créditos ou fatura (se contratado) e envie.

Como funciona o fluxo de envio do E-mail Registrado?

Após criar o pedido, o sistema verifica créditos (ou fatura). Com saldo, o e-mail é enviado imediatamente via provedor de e-mail registrado. O status é atualizado conforme: Entregue (aceito pelo servidor do destinatário) e Lido (quando o destinatário abre a mensagem — você pode ser notificado em escrybe.com.br/config). Se o servidor do destinatário adiar a entrega, o crédito pode ser reembolsado e você será avisado.

Onde consultar pedidos e gerar relatório pericial?

Na página Meus Pedidos (E-mail Registrado) você pode filtrar por período, ordenar e ver detalhes de cada envio. Para pedidos entregues, use o botão Relatório Pericial para gerar um PDF contendo: dados do e-mail, carimbo do tempo ICP-Brasil, hash da mensagem, confirmação de entrega e — quando o e-mail foi lido — dados de leitura (IP, trilha do navegador, carimbo de leitura). O relatório serve como prova documental em juízo.

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

Contato

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