Pular para o conteúdo principal

Webhook

A integração com o Webhook conecta a sua conta ao idworks e sincroniza os fluxos correspondentes ao canal — credenciais, regras de sincronização de produtos, importação de pedidos, conciliação financeira e demais ações específicas dele. A configuração reúne 40 parâmetros distribuídos em 7 grupo(s).

Antes de configurar, ative a integração em Configurações → Integrações (aba Integrações Disponíveis), preencha o nome interno e (quando o tipo exigir) passe pelo fluxo de autenticação. A partir daí, os parâmetros abaixo ficam disponíveis em Configurar parâmetros.

Categoria no catálogo do idworks: Outras.


Índice

Conceito

Cadastro e autenticação

Parâmetros por grupo

Referência rápida


O que é a integração Webhook?

É a conexão entre o canal Webhook e o idworks. Ela controla como dados fluem entre os dois sistemas — depende do tipo da integração (a categoria neste caso é Outras), mas em geral cobre uma combinação de credenciais, regras de sincronização, gatilhos automáticos e parâmetros de conciliação.

📍 Onde: menu lateral → Configurações → Integrações → aba Integrações DisponíveisWebhook.


Como ativar a integração?

  1. Acesse Configurações → Integrações.
  2. Na aba Integrações Disponíveis, busque por Webhook e clique no botão +.
  3. Preencha:
    • Conta (apenas multi-conta) — empresa dona da integração.
    • Nome da Integração — texto livre. Útil para distinguir várias instâncias do mesmo tipo.
  4. Clique em Salvar.

A integração aparece imediatamente em Minhas Integrações. Dependendo do tipo, o status inicial é Ativo (quando só requer credencial fixa) ou Não Autenticado (quando depende de autenticação externa).

Pré-requisito: privilégio Criar parametrizações empresa.


Como autenticar e validar as credenciais?

Preencha o grupo Credenciais de Acesso (ver tabela abaixo). Quando a integração pede uma autorização externa (o canal abre a tela de login dele para você liberar o acesso), clique em Autenticar Integração na linha da integração (ícone de cadeado) — uma nova aba abre o login do canal e, ao confirmar, a conexão fica liberada. Para integrações com credencial fixa (usuário/senha/chave), basta preencher os campos e salvar.

Depois de salvar, use a ação Verificar credenciais (quando disponível) para confirmar que o canal responde. O status na listagem reflete o resultado: Ativo = OK, Erro = credencial inválida ou revogada, Não Autenticado = falta concluir o fluxo de autorização.

Pré-requisito: privilégio Editar parametrizações empresa.


Credenciais de Acesso

3 parâmetro(s).

ParâmetroTipoPara que serve
Endpoint / URLTextoEndereço para enviar a requisição POST. Deve iniciar com HTTPS
Chave header autorizaçãoTextoChave no header que vai ser enviada a autenticação. Ex. Authorization
AutenticaçãoSenhaValor para enviar na chama informada anteriormente

Fiscal Produto

4 parâmetro(s).

ParâmetroTipoPara que serve
Emissão de NFSim/NãoNotificação sempre que houver alguma emissão de nota fiscal
Cancelamento de NFSim/NãoNotificação sempre que houver um cancelamento de nota fiscal
Inutilização de NFSim/NãoNotificação sempre que houver inutilização de nota fiscal
NF denegadaSim/NãoNotificação sempre que uma nota fiscal for denegada ao tentar emitir

Logística (WMS)

5 parâmetro(s).

ParâmetroTipoPara que serve
Finalizar recebimentoSim/NãoNotificação sempre que um recebimento for finalizado
Tranferência armazém / endereçoSim/NãoNotificação sempre que for realizado uma transferência entre armazéns ou endereços
Finalizar inventárioSim/NãoNotificação sempre que um inventário for finalizado
Ajuste estoqueSim/NãoNotificação sempre que for realizado um ajuste de estoque
Finalizar recebimentoSim/NãoNotificação sempre que um recebimento for criado

Anúncio

6 parâmetro(s).

ParâmetroTipoPara que serve
Criação anúncioSim/NãoNotificação sempre que houver a criação de um anúncio
Edição anúncioSim/NãoNotificação sempre que houver alguma edição em um anúncio
Deletar anúncioSim/NãoNotificação sempre que deletar um anúncio
Criação variação anúncioSim/NãoNotificação sempre que houver a criação de uma variação anúncio
Edição variação anúncioSim/NãoNotificação sempre que houver alguma edição em uma variação de anúncio
Deletar variação anúncioSim/NãoNotificação sempre que deletar uma variação anúncio

Pedido

1 parâmetro(s).

ParâmetroTipoPara que serve
Status pedidoSim/NãoNotificação sempre que houver uma alteração no status de algum pedido

Transporte

5 parâmetro(s).

ParâmetroTipoPara que serve
Tracking entregueSim/NãoNotificação sempre que um pedido tiver o tracking entregue
Tracing em andamentoSim/NãoNotificação sempre que um pedido tiver o tracking em andamento
Tracking atençãoSim/NãoNotificação sempre que um pedido tiver o tracking em atenção
Tracking saiu para entregaSim/NãoNotificação sempre que um pedido tiver o tracking saiu para entrega
Tracking extraviadoSim/NãoNotificação sempre que um pedido tiver o tracking extraviado

Produto

16 parâmetro(s).

ParâmetroTipoPara que serve
Criação skuSim/NãoNotificação sempre que houver a criação de um SKU
Edição skuSim/NãoNotificação sempre que houver alguma edição em um SKU
Edição preço skuSim/NãoNotificação sempre que houver alguma edição no preço de um SKU
Criação preço skuSim/NãoNotificação sempre que houver alguma criação de preço de um SKU
Edição fornecedor skuSim/NãoNotificação sempre que houver alguma edição de um fornecedor de um SKU
Criação fornecedor skuSim/NãoNotificação sempre que houver alguma criação de fornecedor de um SKU
Criação codigo de barras adicional skuSim/NãoNotificação sempre que houver alguma criação de codigo de barras adicional de um SKU
Deletar codigo de barras adicional skuSim/NãoNotificação sempre que houver deletar um codigo de barras adicional de um SKU
Criação variação skuSim/NãoNotificação sempre que houver alguma criação de variação de um SKU
Deletar variação skuSim/NãoNotificação sempre que houver deletar uma variação de um SKU
Criação codigo de barras embalagem skuSim/NãoNotificação sempre que houver alguma criação de codigo de barras embalagem de um SKU
Edição codigo de barras embalagem skuSim/NãoNotificação sempre que houver alguma edição de codigo de barras embalagem de um SKU
Deletar codigo de barras embalagem skuSim/NãoNotificação sempre que houver deletar de codigo de barras embalagem de um SKU
Deletar skuSim/NãoNotificação sempre que deletar um SKU
Deletar preço skuSim/NãoNotificação sempre que deletar preço de um SKU
Deletar fornecedor skuSim/NãoNotificação sempre que deletar um fornecedor de um SKU

Privilégios da tela

Esta tela tem privilégios próprios que controlam o que cada usuário pode fazer. Configure os perfis de acesso em Configurações → Perfis de Acesso vinculando os privilégios abaixo aos grupos desejados. Quando o usuário não tem o privilégio, a ação correspondente fica desabilitada na tela.

PrivilégioLibera
Visualizar integraçõesAcesso à tela de Integrações e a esta página de configuração.
Criar parametrizações empresaAtivar a integração (botão + no catálogo).
Editar parametrizações empresaConfigurar parâmetros, editar nome e status, autenticar e validar credenciais.
Deletar parametrizações empresaExcluir a integração.