Este webhook é disparado sempre que uma mensagem da Caixa Postal for consultada pelo sistema.
O tipo do documento deve ser identificado por meio do campo:
“PastaPrincipal” = “Caixa Postal”.
Valores possíveis:
|
Valor |
Significado |
|---|---|
| Caixa Postal | Notificação de nova mensagem de Caixa Postal para a empresa. |
A estrutura do JSON é única para ambos os tipos de envio.
Alguns campos podem ou não estar presentes, dependendo do contexto do envio e da configuração da pasta.
{
"Status": {
"tipo": "string",
"descricao": "Status textual da mensagem.",
"possiveisValores": [
"Mensagem: NÃO LIDA",
"Mensagem: LIDA"
]
},
"Assunto": {
"tipo": "string",
"descricao": "Nome da pasta ou categoria principal da comunicação."
},
"IdPasta": {
"tipo": "number",
"descricao": "Identificador interno da pasta principal."
},
"Mensagem": {
"tipo": "object",
"descricao": "Objeto contendo os dados detalhados da mensagem.",
"estrutura": {
"Lido": {
"tipo": "boolean",
"descricao": "Indica se a mensagem já foi visualizada."
},
"Link": {
"tipo": "string",
"descricao": "URL direta da mensagem no portal e-CAC."
},
"Assunto": {
"tipo": "string",
"descricao": "Assunto principal da mensagem recebida."
},
"EnviadaEm": {
"tipo": "datetime",
"formato": "ISO-8601",
"descricao": "Data original de envio da mensagem."
},
"Relevante": {
"tipo": "boolean",
"descricao": "Indica se a mensagem foi marcada como relevante."
},
>
"ExibidaAte": {
"tipo": "datetime",
"formato": "ISO-8601",
"descricao": "Data limite para exibição da mensagem."
}
}
},
"Subpasta": {
"tipo": "string",
"descricao": "Nome da subpasta relacionada à empresa."
},
"Atributos": {
"tipo": "object",
"descricao": "Informações complementares da mensagem.",
"estrutura": {
"Tags": {
"tipo": "array<string>",
"descricao": "Lista de tags associadas à mensagem."
},
"Protocolo": {
"tipo": "string",
"descricao": "Número de protocolo da comunicação."
}
}
},
"IdSubpasta": {
"tipo": "number",
"descricao": "Identificador interno da subpasta."
},
"DataCriacao": {
"tipo": "datetime",
"formato": "ISO-8601",
"descricao": "Data/hora de criação do registro no sistema."
},
"Destinatarios": {
"tipo": "array<object>",
"descricao": "Lista de empresas destinatárias da mensagem.",
"estrutura": {
"IdEmpresa": {
"tipo": "number",
"descricao": "Identificador interno da empresa."
},
"CnpjEmpresa": {
"tipo": "string",
"descricao": "CNPJ da empresa destinatária."
},
"NomeEmpresa": {
"tipo": "string",
"descricao": "Nome empresarial da empresa destinatária."
}
}
},
"TipoMovimento": {
"tipo": "number",
"descricao": "0 - Inserido, - 1 editado"
},
"PastaPrincipal": {
"tipo": "string",
"descricao": "Nome completo da pasta principal."
},
"IdCodigoDocumento": {
"tipo": "number",
"descricao": "Código identificador do documento relacionado."
}
}
{
"Status": "Mensagem: NÃO LIDA",
"Assunto": "e-CAC - Caixa Postal",
"IdPasta": 17,
"Mensagem": {
"Lido": false,
"Link": "https://cav.receita.fazenda.gov.br/ecac/Aplicacao.aspx?id=6&origem=pesquisa",
"Assunto": "Vencimento de Certidão Conjunta",
"EnviadaEm": "2013-08-29T00:00:00",
"Relevante": false,
"ExibidaAte": "2028-08-25T00:00:00"
},
"Subpasta": "e-CAC - Caixa Postal - Empresa 08240842000122",
"Atributos": {
"Tags": [],
"Protocolo": "227000175"
},
"IdSubpasta": 451,
"DataCriacao": "2026-05-18T19:01:15.228331",
"Destinatarios": [
{
"IdEmpresa": 546,
"CnpjEmpresa": "00000842000000",
"NomeEmpresa": "REPRESENTANTE COMERCIAL-Matriz"
}
],
"TipoMovimento": 0,
"PastaPrincipal": "Caixa Postal: e-CAC - Caixa Postal",
"IdCodigoDocumento": 10022
}
Para configurar o módulo Caixa Postal, confira nosso material especifico: