Webhook
A integração Webhook faz o idworks enviar notificações (POST em JSON) para o endereço que você informar, uma por evento ligado nos parâmetros (pedido, estoque, recebimento, transporte etc.). Ela não importa nem sincroniza nada de volta. A configuração reúne 43 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 (o Webhook não tem autenticação externa). A partir daí, os parâmetros abaixo ficam disponíveis na Configuração (ícone de engrenagem) da integração.
Categoria no catálogo do idworks: Outros.
Índice
Conceito
Cadastro e autenticação
Parâmetros por grupo
Referência rápida
O que é a integração Webhook?
É a conexão que faz o idworks avisar o seu sistema. Ela só envia: a cada evento ligado nos parâmetros, o idworks faz um POST em JSON para o Endpoint / URL cadastrado (a categoria neste caso é Outros).
📍 Onde: menu lateral → Configurações → Integrações → aba Integrações Disponíveis → Webhook.
Como ativar a integração?
- Acesse Configurações → Integrações.
- Na aba Integrações Disponíveis, busque por Webhook e clique no botão +.
- 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.
- Clique em Salvar.
A integração aparece imediatamente em Minhas Integrações, já com status Ativo: o Webhook não depende de autenticação externa.
Pré-requisito: privilégio Criar parametrizações empresa.
Como autenticar e validar as credenciais?
O Webhook não tem autorização externa: o botão Autenticar Integração não aparece na linha dele. Preencha o grupo Credenciais de Acesso (ver tabela abaixo) — Endpoint / URL, o endereço que recebe o POST (use HTTPS), Chave header autorização e Autenticação — e salve. Em cada envio, o idworks manda esse par chave/valor no cabeçalho da requisição; sem os dois preenchidos, o POST sai sem ele. Veja Como funciona a autenticação no envio?.
Para conferir se o destino respondeu, veja o log de cada envio em Como ver o conteúdo completo enviado e a resposta do destino?.
Pré-requisito: privilégio Editar parametrizações empresa.
Credenciais de Acesso
3 parâmetro(s).
| Parâmetro | Tipo | Para que serve |
|---|---|---|
| Endpoint / URL | Texto | Endereço para enviar a requisição POST. Deve iniciar com HTTPS |
| Chave header autorização | Texto | Chave no header que vai ser enviada a autenticação. Ex. Authorization |
| Autenticação | Senha | Valor para enviar na chama informada anteriormente |
Fiscal Produto
4 parâmetro(s).
| Parâmetro | Tipo | Para que serve |
|---|---|---|
| Emissão de NF | Sim/Não | Notificação sempre que houver alguma emissão de nota fiscal |
| Cancelamento de NF | Sim/Não | Notificação sempre que houver um cancelamento de nota fiscal |
| Inutilização de NF | Sim/Não | Notificação sempre que houver inutilização de nota fiscal |
| NF denegada | Sim/Não | Notificação sempre que uma nota fiscal for denegada ao tentar emitir |
Logística (WMS)
5 parâmetro(s).
| Parâmetro | Tipo | Para que serve |
|---|---|---|
| Finalizar recebimento | Sim/Não | Notificação sempre que um recebimento for finalizado |
| Tranferência armazém / endereço | Sim/Não | Notificação sempre que for realizado uma transferência entre armazéns ou endereços |
| Finalizar inventário | Sim/Não | Notificação sempre que um inventário for finalizado |
| Ajuste estoque | Sim/Não | Notificação sempre que for realizado um ajuste de estoque |
| Criar recebimento | Sim/Não | Notificação sempre que um recebimento for criado |
Anúncio
6 parâmetro(s).
| Parâmetro | Tipo | Para que serve |
|---|---|---|
| Criação anúncio | Sim/Não | Notificação sempre que houver a criação de um anúncio |
| Edição anúncio | Sim/Não | Notificação sempre que houver alguma edição em um anúncio |
| Deletar anúncio | Sim/Não | Notificação sempre que deletar um anúncio |
| Criação variação anúncio | Sim/Não | Notificação sempre que houver a criação de uma variação anúncio |
| Edição variação anúncio | Sim/Não | Notificação sempre que houver alguma edição em uma variação de anúncio |
| Deletar variação anúncio | Sim/Não | Notificação sempre que deletar uma variação anúncio |
Pedido
1 parâmetro(s).
| Parâmetro | Tipo | Para que serve |
|---|---|---|
| Status pedido | Sim/Não | Notificação sempre que houver uma alteração no status de algum pedido |
Transporte
5 parâmetro(s).
| Parâmetro | Tipo | Para que serve |
|---|---|---|
| Tracking entregue | Sim/Não | Notificação sempre que um pedido tiver o tracking entregue |
| Tracking em andamento | Sim/Não | Notificação sempre que um pedido tiver o tracking em andamento |
| Tracking atenção | Sim/Não | Notificação sempre que um pedido tiver o tracking em atenção |
| Tracking saiu para entrega | Sim/Não | Notificação sempre que um pedido tiver o tracking saiu para entrega |
| Tracking extraviado | Sim/Não | Notificação sempre que um pedido tiver o tracking extraviado |
Produto
19 parâmetro(s).
| Parâmetro | Tipo | Para que serve |
|---|---|---|
| Criação sku | Sim/Não | Notificação sempre que houver a criação de um SKU |
| Edição sku | Sim/Não | Notificação sempre que houver alguma edição em um SKU |
| Edição preço sku | Sim/Não | Notificação sempre que houver alguma edição no preço de um SKU |
| Criação preço sku | Sim/Não | Notificação sempre que houver alguma criação de preço de um SKU |
| Edição fornecedor sku | Sim/Não | Notificação sempre que houver alguma edição de um fornecedor de um SKU |
| Criação fornecedor sku | Sim/Não | Notificação sempre que houver alguma criação de fornecedor de um SKU |
| Criação codigo de barras adicional sku | Sim/Não | Notificação sempre que houver alguma criação de codigo de barras adicional de um SKU |
| Deletar codigo de barras adicional sku | Sim/Não | Notificação sempre que houver deletar um codigo de barras adicional de um SKU |
| Criação variação sku | Sim/Não | Notificação sempre que houver alguma criação de variação de um SKU |
| Deletar variação sku | Sim/Não | Notificação sempre que houver deletar uma variação de um SKU |
| Criação codigo de barras embalagem sku | Sim/Não | Notificação sempre que houver alguma criação de codigo de barras embalagem de um SKU |
| Edição codigo de barras embalagem sku | Sim/Não | Notificação sempre que houver alguma edição de codigo de barras embalagem de um SKU |
| Deletar codigo de barras embalagem sku | Sim/Não | Notificação sempre que houver deletar de codigo de barras embalagem de um SKU |
| Deletar sku | Sim/Não | Notificação sempre que deletar um SKU |
| Deletar preço sku | Sim/Não | Notificação sempre que deletar preço de um SKU |
| Deletar fornecedor sku | Sim/Não | Notificação sempre que deletar um fornecedor de um SKU |
| Adicionar imagem sku | Sim/Não | Notificação sempre que adicionar uma imagem a um SKU |
| Atualizar imagem sku | Sim/Não | Notificação sempre que atualizar a ordem de imagem de um SKU |
| Deletar imagem sku | Sim/Não | Notificação sempre que deletar uma imagem 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égio | Libera |
|---|---|
| Visualizar integrações | Acesso à tela de Integrações e a esta página de configuração. |
| Criar parametrizações empresa | Ativar a integração (botão + no catálogo). |
| Editar parametrizações empresa | Abrir a Configuração (engrenagem) e editar nome e status. |
| Deletar parametrizações empresa | Excluir a integração. |