Webhook
Envio de notificações para seu sistema
Notas importantesTodas as chamadas esperam como sucesso um http code 200A notificação do webhook é enviada apenas UMA VEZToda chamada grava log das tentativas de processamento e tentativa de chamada do webhook, e podem ser vistas no GestãoO timeout de chamada do webhook é de 3 segundos |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificação de teste para configuração no emitente
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "TESTE",
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ=="
}
|
Responses
| Code | Description |
| 200 |
Sucesso |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificação de autorização dos documentos com sucesso na resposta
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "NFE", // pode ser (NFE, NFCE, CTE, CTEOS, MDFE, NFSE, BPE, GNRE)
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ==",
"sucesso": true,
"codigo": 100,
"mensagem": "Autorizado o uso do NF-e",
"chave": "50190813188739000110550010000012001581978549"
}
|
Responses
| Code | Description |
| 200 |
Sucesso |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificação de autorização dos documentos com alguma falha
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "NFE", // pode ser (NFE, NFCE, CTE, CTEOS, MDFE, NFSE, BPE)
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ==",
"sucesso": false,
"codigo": 5034,
"mensagem": "Autorizador não respondeu em 5 tentativas, aguardando mais 1 hora para tentar novamente."
}
|
Responses
| Code | Description |
| 200 |
Sucesso |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificações do DF-e para documentos modelo 55
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "DFE55NF",
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ==",
"tipo": "dfe_nfe",
"chave": "50190813188739000110550010000012001581978549",
"emissao": "2019-08-30T11:25:22-04:00",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==", // BASE 64
"razao": "EMPRESA TESTE",
"valor": "10.00",
"status": "101"
}
|
Responses
| Code | Description |
| 200 |
Sucesso |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificações do DF-e para eventos do modelo 55
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "DFE55EV",
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ==",
"tipo": "dfe_nfe_event",
"chave": "50190813188739000110550010000012001581978549",
"emissao": "2019-08-30T11:25:22-04:00",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"codigo_evento": "Homologado o cancelamento da NF-e",
"descricao_evento": "110111"
}
|
Responses
| Code | Description |
| 200 |
Sucesso |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificações do DF-e para documentos modelo 57
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "DFE57CT",
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ==",
"tipo": "dfe_cte",
"chave": "50190813188739000110570010000012001581978549",
"emissao": "2019-08-30T11:25:22-04:00",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==", // BASE 64
"razao": "EMPRESA TESTE",
"valor": "10.00",
"status": "101"
}
|
Responses
| Code | Description |
| 200 |
Sucesso |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificações do DF-e para eventos do modelo 57
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "DFE55EV",
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ==",
"tipo": "dfe_cte_event",
"chave": "50190813188739000110570010000012001581978549",
"emissao": "2019-08-30T11:25:22-04:00",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"codigo_evento": "Homologado o cancelamento do CT-e",
"descricao_evento": "110111"
}
|
Responses
| Code | Description |
| 200 |
Sucesso |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificações do DF-e para documentos modelo 67
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "DFE67CT",
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ==",
"tipo": "dfe_cte",
"chave": "50190813188739000110670010000012001581978549",
"emissao": "2019-08-30T11:25:22-04:00",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==", // BASE 64
"razao": "EMPRESA TESTE",
"valor": "10.00",
"status": "101"
}
|
Responses
| Code | Description |
| 200 |
Sucesso |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificações do DF-e para eventos do modelo 67
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "DFE55EV",
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ==",
"tipo": "dfe_cte_event",
"chave": "50190813188739000110570010000012001581978549",
"emissao": "2019-08-30T11:25:22-04:00",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"codigo_evento": "Homologado o cancelamento do CT-e",
"descricao_evento": "110111"
}
|
Responses
| Code | Description |
| 200 |
Sucesso |
POST{URL_CONFIGURADA_NO_EMITENTE}/
Envia notificações do DF-e para documentos de Notas de Serviço
Parameters
| Name | Description |
|---|---|
|
body *
(body)
|
{
"origem": "DFENFSE",
"cnpj_cpf": "28586684000174",
"signature": "PD94bWwgdmVyc2lvbjPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ0iMS4wIiBlbmNvZGluZ==",
"tipo": "dfe_nfse",
"chave": "35220533722532000191903080000001051050520224",
"codigo_verificacao": "EDCJPP4U",
"numero": "105",
"discriminacao": "Serviço de cabeleireira",
"emissao": "2019-08-30T11:25:22-04:00",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"razao": "EMPRESA TESTE",
"valor": "10.00",
"status": "101"
}
|
Responses
| Code | Description |
| 200 |
Sucesso |