FácilZap API
  1. FácilZap API
FácilZap API
  • FácilZap API
    • Introdução
    • Ambientes
    • Tipos de Usuários
    • Autenticação
    • Limites
    • Endpoints
    • Webhooks
    • Referência da API
  1. FácilZap API

Webhooks

Disponibilizamos webhooks para que sistemas externos possam ser notificados automaticamente sobre eventos importantes que ocorrem em nossa plataforma, como a criação ou atualização de pedidos.

Passo a Passo para Configurar os Webhooks#

1
Acesse sua conta na plataforma FácilZap.
2
No menu lateral, clique em Integrações.
3
Clique no submenu Webhooks.
4
Configure o URL do Webhook e ative os eventos desejados.
5
Clique em Salvar.
Atenção
A URL informada para recebimento dos webhooks deve ser válida e estar preparada para receber requisições HTTP, retornando obrigatoriamente o código de status 200.
Caso ocorra alguma falha no envio, nosso sistema realizará automaticamente até 3 tentativas de entrega antes de registrar o evento como não entregue.

Exemplo de Dados Enviados#

Os dados do webhook são enviados no formato JSON por meio de uma requisição HTTP POST para a URL informada pelo cliente.

Webhook de Pedidos#

{
  "id": "00000000-0000-0000-0000-000000000000",
  "evento": "pedido_criado",
  "dados": {
    "id": 123456,
    "codigo": "ABC123",
    "data": "2025-01-01 12:00:00",
    "catalogo": {
      "id": 0,
      "nome": "Catálogo Padrão"
    },
    "vendedor": {
      "id": 0,
      "nome": "Loja"
    },
    "cliente": {
      "id": 1,
      "nome": "Cliente Exemplo",
      "cpf_cnpj": "000.000.000-00",
      "whatsapp": "11999999999",
      "whatsapp_ddi": 55,
      "whatsapp_e164": "+5511999999999",
      "pessoa_estrangeira": "0",
      "telefone": "(11) 99999-9999",
      "telefone_e164": "+5511999999999",
      "telefone_ddi": "55",
      "telefone_country": "br",
      "email": "cliente@exemplo.com",
      "data_nascimento": "01/01/1990",
      "pais": "BR",
      "cep": "00000000",
      "estado": "SP",
      "cidade": "São Paulo",
      "bairro": "Centro",
      "endereco": "Rua Exemplo",
      "numero": "100",
      "complemento": "Apto 1"
    },
    "forma_entrega": {
      "id": 1,
      "nome": "Retirada"
    },
    "pagamentos": [
      {
        "id": 1,
        "forma_pagamento": {
          "id": "pix",
          "nome": "PIX"
        },
        "metodo": null,
        "parcelas": 1,
        "cod_transacao": null,
        "data": "2025-01-01 12:00:00",
        "valor": 100,
        "taxas": 0,
        "taxas_externas": 0,
        "taxas_parcelamento": 0,
        "descontos": 0,
        "link": "interno",
        "status": "pendente",
        "comprovante": null
      }
    ],
    "subtotal": 90,
    "valor_frete": 10,
    "info_extra_frete": [],
    "desconto": 0,
    "desconto_sistema": 0,
    "descontos_info": [],
    "total": 100,
    "comissao_vendedor": 0,
    "orcamento": false,
    "status": true,
    "status_pago": false,
    "status_em_separacao": false,
    "status_separado": false,
    "status_despachado": false,
    "status_entregue": false,
    "opcao_tabela_frete": {
      "nome": "Bairro Exemplo",
      "valor": "10"
    },
    "forma_entrega_campo_extra": null,
    "prazo_frete": null,
    "editado_por": null,
    "observacoes": "",
    "origem": "api",
    "impresso": 0,
    "estoque_baixado": true,
    "utm": {
      "id": null,
      "source": null,
      "medium": null,
      "campaign": null
    },
    "conferido_em": null,
    "conferido_por": null,
    "cancelamento_personalizado": null,
    "nfe": [],
    "nfce": [],
    "etiqueta_envio_gerada": false,
  }
}
Página anterior
Endpoints
Próxima página
Referência da API
Built with