{"info":{"_postman_id":"b50569cb-4b21-4863-b360-52b31cc8b046","name":"Documentação Webhook","description":"

Um webhook é um mecanismo que permite que um sistema envie informações automaticamente para outro sistema em tempo real quando um evento acontece.

\n

Cada método a esquerda podemos ter mais de um evento. Veja a lista de eventos possívei em cada método.

\n

Esse evento será adicionado na sua URL como um parâmetro GET para que possa identificá-lo em sua estrutura.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9868245","collectionId":"b50569cb-4b21-4863-b360-52b31cc8b046","publishedId":"2sBXcHhyfT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-09T18:33:05.000Z"},"item":[{"name":"cliente","id":"d796950e-438b-48d9-b4fd-be264329fae9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cliente\": {\r\n \"cod_externo\": null,\r\n \"tipo_pessoa\": \"F\",\r\n \"nome_completo\": \"Manoel da silva\",\r\n \"cpf\": \"11111111111\",\r\n \"data_nascimento\": \"10/03/1986\",\r\n \"sexo\": \"Nenhum\",\r\n \"nome_empresa\": \"\",\r\n \"responsavel_empresa\": \"\",\r\n \"cnpj\": \"\",\r\n \"rg\": null,\r\n \"ie\": \"\",\r\n \"email\": \"nome@email.com\",\r\n \"cep\": \"03962-040\",\r\n \"endereco\": \"Rua Maria Luísa do Val Penteado\",\r\n \"numero\": \"686\",\r\n \"complemento\": \"Casa\",\r\n \"bairro\": \"Cidade São Mateus\",\r\n \"cidade\": \"São Paulo\",\r\n \"estado\": \"SP\",\r\n \"pais\": \"Brasil\",\r\n \"moeda\": \"BRL\",\r\n \"telefone_fixo\": \"\",\r\n \"codigo_ddi\": \"55\",\r\n \"telefone_celular\": \"11999998888\",\r\n \"operadora_celular\": null,\r\n \"tipo_cliente\": \"Revendedor\",\r\n \"data_cadastro\": \"2026-02-24 00:59:40\",\r\n \"assinar_newsletter\": \"S\",\r\n \"instagram\": \"\",\r\n \"compra_minima_atacado\": \"0.00\",\r\n \"compra_maxima_atacado\": \"0.00\",\r\n \"condicao_diferenciada\": \"0\",\r\n \"liberado_para_comprar\": true,\r\n \"origem_acesso\": \"Aplicativo Celular\",\r\n \"utm\": \"\",\r\n \"lgpd_aceite\": \"S\",\r\n \"lgpd_datahorario\": null,\r\n \"vendedor\": {\r\n \"nome\": \"Nome do vendedor\",\r\n \"email\": \"emailvendedor@site.com.br\",\r\n \"whatsapp\": \"3599999999\"\r\n }\r\n },\r\n \"loja\": {\r\n \"nome\": \"ViaShopModa\",\r\n \"cnpj\": \"999999990000199\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{SUA_URL}?evento={EVENTO_CLIENTE}","description":"\n","urlObject":{"host":["{SUA_URL}"],"query":[{"key":"evento","value":"{EVENTO_CLIENTE}"}],"variable":[]}},"response":[],"_postman_id":"d796950e-438b-48d9-b4fd-be264329fae9"},{"name":"cliente.enviar_mensagem","id":"1a478695-1b83-4550-8f66-71153e2b2b8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cliente\": {\r\n \"nome_completo\": \"João da silva\",\r\n \"codigo_ddi\": \"55\",\r\n \"telefone_celular\": \"35999990000\",\r\n \"vendedor_nome\": \"Nome do vendedor\",\r\n \"vendedor_ddiwhatsapp\": \"55\",\r\n \"vendedor_whatsapp\": \"359988880000\",\r\n \"codigo_mensagem\": \"SAUDACAO\",\r\n \"mensagem\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{SUA_URL}?evento=cliente.enviar_mensagem","urlObject":{"host":["{SUA_URL}"],"query":[{"key":"evento","value":"cliente.enviar_mensagem"}],"variable":[]}},"response":[],"_postman_id":"1a478695-1b83-4550-8f66-71153e2b2b8d"},{"name":"lead","id":"092345f3-3b6a-4dbf-adc8-6c0b3017109e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"leads\": [\r\n {\r\n \"id\": \"ODgy\",\r\n \"nome\": \"Teste Webook\",\r\n \"email\": null,\r\n \"ddi\": \"55\",\r\n \"whatsapp\": \"76564338888\",\r\n \"status_qualificacao\": \"Aguardo\",\r\n \"data_cadastro\": \"2026-02-27 15:40:27\",\r\n \"origem_pagina\": \"inicial\",\r\n \"origem_acesso\": \"Acesso Direto\",\r\n \"utm\": \"\",\r\n \"vendedor_nome\": \"Gustavo Araujo\",\r\n \"vendedor_email\": \"gustavocaraujo@gmail.com\",\r\n \"vendedor_whatsapp\": \"35988950438\",\r\n \"codigo_mensagem\": \"SAUDACAO\", // atributo usado somente para o evento lead.enviar_mensagem\r\n \"mensagem\": \"Olá, Teste!\" // atributo usado somente para o evento lead.enviar_mensagem\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{SUA_URL}?evento={EVENTO_LEAD}","description":"

Leads são cadastros com informações reduzidas (nome, email, whatsapp) que são coletados em locais estratégicos dentro da plataforma.

\n\n","urlObject":{"host":["{SUA_URL}"],"query":[{"key":"evento","value":"{EVENTO_LEAD}"}],"variable":[]}},"response":[],"_postman_id":"092345f3-3b6a-4dbf-adc8-6c0b3017109e"},{"name":"pagamento","id":"d5ea7fbf-29b1-4206-8f4c-90ad91cb873a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"9999\",\r\n \"valor_pago\": \"1847.82\",\r\n \"numero_pedido\": \"111111\",\r\n \"rastreio_pedido\": \"1\",\r\n \"parcelas\": \"3\",\r\n \"nome_integracao\": \"ViaShopPay\",\r\n \"tipo\": \"cartao_credito\",\r\n \"data_criacao\": \"2026-02-27 16:02:58\",\r\n \"data_alteracao\": \"2026-02-27 16:03:04\",\r\n \"status_viashop\": \"pago\",\r\n \"bandeira\": \"visa\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{SUA_URL}?evento={EVENTO_PAGAMENTO}","description":"\n","urlObject":{"host":["{SUA_URL}"],"query":[{"key":"evento","value":"{EVENTO_PAGAMENTO}"}],"variable":[]}},"response":[],"_postman_id":"d5ea7fbf-29b1-4206-8f4c-90ad91cb873a"},{"name":"pedido","id":"cc2d8af0-15a3-4a43-97cd-e2b7a2a22b85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cliente\": {\r\n \"cod_externo\": null,\r\n \"tipo_pessoa\": \"F\",\r\n \"nome_completo\": \"Manoel da silva\",\r\n \"cpf\": \"11111111111\",\r\n \"data_nascimento\": \"10/03/1986\",\r\n \"sexo\": \"Nenhum\",\r\n \"nome_empresa\": \"\",\r\n \"responsavel_empresa\": \"\",\r\n \"cnpj\": \"\",\r\n \"rg\": null,\r\n \"ie\": \"\",\r\n \"email\": \"nome@email.com\",\r\n \"cep\": \"03962-040\",\r\n \"endereco\": \"Rua Maria Luísa do Val Penteado\",\r\n \"numero\": \"686\",\r\n \"complemento\": \"Casa\",\r\n \"bairro\": \"Cidade São Mateus\",\r\n \"cidade\": \"São Paulo\",\r\n \"estado\": \"SP\",\r\n \"pais\": \"Brasil\",\r\n \"moeda\": \"BRL\",\r\n \"telefone_fixo\": \"\",\r\n \"codigo_ddi\": \"55\",\r\n \"telefone_celular\": \"11999998888\",\r\n \"operadora_celular\": null,\r\n \"tipo_cliente\": \"Revendedor\",\r\n \"data_cadastro\": \"2026-02-24 00:59:40\",\r\n \"assinar_newsletter\": \"S\",\r\n \"instagram\": \"\",\r\n \"compra_minima_atacado\": \"0.00\",\r\n \"compra_maxima_atacado\": \"0.00\",\r\n \"condicao_diferenciada\": \"0\",\r\n \"liberado_para_comprar\": true,\r\n \"origem_acesso\": \"Aplicativo Celular\",\r\n \"utm\": \"\",\r\n \"lgpd_aceite\": \"S\",\r\n \"lgpd_datahorario\": null,\r\n \"vendedor\": {\r\n \"nome\": \"Nome do vendedor\",\r\n \"email\": \"emailvendedor@site.com.br\",\r\n \"whatsapp\": \"3599999999\"\r\n }\r\n },\r\n \"pedido\": {\r\n \"numero_pedido\": \"111111\",\r\n \"numero_pedido_externo\": null,\r\n \"status_pedido\": \"Pedido em análise\",\r\n \"status_pedido_externo\": \"aberto\",\r\n \"numero_pedido_encode\": \"8vdstg8\",\r\n \"data_pedido\": \"2026-02-27 16:19:37\",\r\n \"data_alteracao_pedido\": \"2026-02-27 16:19:37\",\r\n \"moeda\": \"BRL\",\r\n \"valor\": \"1441.10\",\r\n \"desconto\": \"0.00\",\r\n \"tipo_frete\": \"Cotar Outras Transportadoras\",\r\n \"valor_frete\": \"0.00\",\r\n \"previsao_frete\": \"0\",\r\n \"cotacao_frete\": \"loja\",\r\n \"forma_pagamento\": null,\r\n \"utm\": \"\",\r\n \"cep_entrega\": \"99999-000\",\r\n \"endereco_entrega\": \"Avenida Brasil\",\r\n \"numero_entrega\": \"90\",\r\n \"complemento_entrega\": \"\",\r\n \"bairro_entrega\": \"central\",\r\n \"cidade_entrega\": \"Centro\",\r\n \"estado_entrega\": \"MG\",\r\n \"url_pedido\": \"string\",\r\n \"rastreio\": \"01\",\r\n \"tipo_pedido\": \"ATACADO\",\r\n \"foi_pago\": \"N\",\r\n \"rastreio_frete\": null,\r\n \"vendedor\": {\r\n \"nome\": \"Nome do vendedor\",\r\n \"email\": \"emailvendedor@site.com.br\",\r\n \"whatsapp\": \"3599999999\"\r\n },\r\n \"catalogo_virtual\": null\r\n },\r\n \"produtos\": [\r\n {\r\n \"descricao\": \"CROPPED ALCA DE RENDA\",\r\n \"cod_referencia\": \"3438\",\r\n \"cod_produto\": \"18\",\r\n \"cod_grade\": \"5\",\r\n \"grade\": \"G\",\r\n \"cod_estampa\": \"273\",\r\n \"estampa_descricao\": \"HARMONIA\",\r\n \"quantidade\": \"1\",\r\n \"preco\": \"159.90\",\r\n \"cod_barras\": \"000000062169\",\r\n \"saldo_estoque\": \"6\",\r\n \"cod_externo\": null,\r\n \"tag\": \"cropped-renda-encanto\",\r\n \"url_produto\": \"url do produto\",\r\n \"fotos\": [\r\n {\r\n \"arquivo\": \"url da foto\",\r\n }\r\n ]\r\n },\r\n {...\r\n },\r\n ],\r\n \"loja\": {\r\n \"nome\": \"ViaShopModa\",\r\n \"cnpj\": \"999999990000199\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{SUA_URL}?evento={EVENTO_PEDIDO}","description":"\n","urlObject":{"host":["{SUA_URL}"],"query":[{"key":"evento","value":"{EVENTO_PEDIDO}"}],"variable":[]}},"response":[],"_postman_id":"cc2d8af0-15a3-4a43-97cd-e2b7a2a22b85"},{"name":"produto","id":"32a4d8f8-f0e8-4b31-b637-fe974e1b999a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"produto\": [\r\n {\r\n \"id\": \"87\",\r\n \"cod_externo\": \"P897564\",\r\n \"cod_ref\": \"02064\",\r\n \"titulo\": \"CONJUNTO TIE DYE CANELADO\",\r\n \"descricao\": \"Conjunto Tie Dye
TECIDO: Canelado (COMPOSIÇÃO - 96% Poliéster/ 4% Elastano)

\",\r\n \"preco_atacado\": \"79.90\",\r\n \"preco_varejo\": \"100.10\",\r\n \"ordem\": \"18\",\r\n \"peso\": \"895\", // em gramas\r\n \"altura\": \"5\", // em cm\r\n \"largura\": \"35\", // em cm\r\n \"comprimento\": \"15\", // em cm\r\n \"ncm\": \"\",\r\n \"preco_atacado_promo\": \"99.99\",\r\n \"preco_varejo_promo\": \"125.90\",\r\n \"data_atualizacao\": null,\r\n \"video_produto\": \"\",\r\n \"video_atacado\": \"\",\r\n \"status\": \"S\",\r\n \"colecao\": \"OUTONO 2025\",\r\n \"tipo\": \"CONJUNTO\",\r\n \"cod_tipo\": \"23\",\r\n \"cod_tipo_externo\": null,\r\n \"genero\": \"FEMININO\",\r\n \"fotos\": [\r\n {\r\n \"arquivo\": \"url da foto\",\r\n \"cod_estampa\": 375,\r\n \"estampa\": {\r\n \"id\": \"375\",\r\n \"nome\": \"TIE DYE SUAVE\",\r\n \"tipo\": \"jpg\",\r\n \"arquivo\": \"url da foto da estampa\",\r\n \"cod_externo\": null\r\n }\r\n },\r\n {...\r\n }\r\n {...\r\n }\r\n {...\r\n }\r\n ],\r\n \"estoque\": [\r\n {\r\n \"cod_produto\": \"87\",\r\n \"cod_grade\": \"2\",\r\n \"cod_estampa\": \"375\",\r\n \"quantidade\": \"100\",\r\n \"preco_atacado\": \"79.90\",\r\n \"preco_varejo\": \"100.10\",\r\n \"cod_barras\": \"02064_TDS_P\",\r\n \"cod_externo\": null,\r\n \"nome_grade\": \"P\",\r\n \"cod_grade_externo\": null,\r\n \"nome_estampa\": \"TIE DYE SUAVE \",\r\n \"cod_estampa_externo\": null\r\n },\r\n {}\r\n ],\r\n \"marca\": {\r\n \"id\": 1,\r\n \"nome\": \"ViaShopModa\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{SUA_URL}?evento={EVENTO_PRODUTO}","description":"\n","urlObject":{"host":["{SUA_URL}"],"query":[{"key":"evento","value":"{EVENTO_PRODUTO}"}],"variable":[]}},"response":[],"_postman_id":"32a4d8f8-f0e8-4b31-b637-fe974e1b999a"},{"name":"sacola abandonada","id":"bb3d169e-da6f-439b-bdc6-168c44bdd565","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cliente\": {\r\n \"cod_cliente\": \"3944\",\r\n \"cod_externo\": \"17403084702\",\r\n \"tipo_pessoa\": \"F\",\r\n \"nome_completo\": \"Manoel da silva\",\r\n \"cpf\": \"99999999900\",\r\n \"data_nascimento\": \"1986/03/17\",\r\n \"sexo\": \"Masculino\",\r\n \"nome_empresa\": \"\",\r\n \"responsavel_empresa\": \"\",\r\n \"cnpj\": \"\",\r\n \"rg\": \"Isento\",\r\n \"ie\": \"\",\r\n \"email\": \"nome@email.com.br\",\r\n \"cep\": \"37009000\",\r\n \"endereco\": \"Avenida Imigrantes\",\r\n \"numero\": \"100\",\r\n \"complemento\": \"Casa 3\",\r\n \"bairro\": \"Centro\",\r\n \"cidade\": \"Varginha\",\r\n \"estado\": \"MG\",\r\n \"pais\": \"Brasil\",\r\n \"moeda\": \"BRL\",\r\n \"codigo_ddi\": \"55\",\r\n \"telefone_celular\": \"35988950438\",\r\n \"tipo_cliente\": \"Revendedor\",\r\n \"data_cadastro\": \"2024-03-12 18:10:12\",\r\n \"assinar_newsletter\": \"N\",\r\n \"instagram\": \"\",\r\n \"compra_minima_atacado\": \"0.00\",\r\n \"compra_maxima_atacado\": \"0.00\",\r\n \"condicao_diferenciada\": \"0.00\",\r\n \"liberado_para_comprar\": true,\r\n \"origem_acesso\": \"Acesso Direto\",\r\n \"utm\": \"\",\r\n \"lgpd_aceite\": \"S\",\r\n \"lgpd_datahorario\": \"03/09/2025 12:28:13\",\r\n \"vendedor\": {\r\n \"nome\": \"Gustavo Araujo\",\r\n \"email\": \"email@site.com\",\r\n \"whatsapp\": \"35988880000\"\r\n }\r\n },\r\n \"simulacao\": {\r\n \"data\": \"2026-02-27 06:01:32\",\r\n \"origem_acesso\": \"FacilitaZap\",\r\n \"utm\": \"\",\r\n \"sessao\": \"67fbvvr09809fhg8798dfvg8\",\r\n \"valor_total\": 1037.99,\r\n \"total_produtos\": 23\r\n },\r\n \"produtos\": [\r\n {\r\n \"descricao\": \"SAIA BICOLOR\",\r\n \"cod_referencia\": \"11325\",\r\n \"cod_produto\": \"7\",\r\n \"cod_grade\": \"5\",\r\n \"grade\": \"G\",\r\n \"cod_estampa\": \"204\",\r\n \"estampa_descricao\": \"AREIA\",\r\n \"quantidade\": \"3\",\r\n \"preco\": \"27.99\",\r\n \"cod_barras\": \"\",\r\n \"saldo_estoque\": \"100\",\r\n \"cod_externo\": null,\r\n \"tag\": \"saia-bicolor\",\r\n \"url_produto\": \"url do produto\",\r\n \"foto_principal\": \"url da foto principal do produto\"\r\n },\r\n {...\r\n },\r\n {...\r\n },\r\n {...\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{SUA_URL}?evento={EVENTO_SACOLA_ABANDONADA}","description":"\n","urlObject":{"host":["{SUA_URL}"],"query":[{"key":"evento","value":"{EVENTO_SACOLA_ABANDONADA}"}],"variable":[]}},"response":[],"_postman_id":"bb3d169e-da6f-439b-bdc6-168c44bdd565"}]}