Webhooks

O Omie avisa o seu servidor quando algo muda: pedido faturado, conta paga, produto alterado. Sem ficar perguntando.

Configurar em Meus aplicativos

Quando usar

01Carga inicialpelas listagens da API, uma vez

02Mudançaspelo webhook, assim que acontecem

03Detalhepela API, com o código que o aviso trouxe

Ficar repetindo listagens para ver se algo mudou gasta a cota, chega atrasado e pode ser bloqueado (425).

Configurar

Tenha um endereço https público. Para testar, um coletor como o RequestBin serve.
Cadastre o endereço e escolha os tópicos em Meus aplicativos › Webhooks. É do administrador do aplicativo.
Recarregue o Omie antes de testar: a configuração vale para as sessões abertas depois de salvar.

Teste num aplicativo de demonstração. O aviso sai de mudanças reais: no aplicativo da empresa, o teste mexe em dados de verdade.

O aviso

Um POST com Content-Type: application/json. Exemplo resumido:

POST https://seu-servidor/omie

{
  "messageId": "7f3c1e2a-9b4d-4c6e-8a1f-2d5b6c7e8f90",
  "topic": "ClienteFornecedor.Alterado",
  "event": {
    "codigo_cliente_omie": 2485967412,
    "razao_social": "Cliente Exemplo Ltda"
  },
  "author": {"email": "fulano@empresa.com.br", "name": "Fulano de Tal", "userId": 1234},
  "appKey": "1234567890",
  "appHash": "minha-empresa-1a2b3c",
  "origin": "omie-connect-2.0"
}

Campo	O que é
`messageId`	Identificador do aviso.
`topic`	O tópico do aviso, como na lista abaixo.
`event`	O registro que mudou. Os campos variam com o tópico; para o detalhe completo, consulte a API.
`author`	Quem fez a mudança no Omie: e-mail, nome e código do usuário.
`appKey · appHash`	O aplicativo (a empresa) onde o evento aconteceu. Use para separar empresas.
`origin`	A versão do serviço que enviou o aviso.

Entrega e reentrega

01Evento no Omieentra na fila do endereço, em ordem

02POST no seu endereçoo corpo traz o evento

032xx em até 7 sentregue · o próximo segue

04Sem 2xx3 tentativas em segundos, depois a cada 10 min por 5 dias

	Primeiras tentativas	Depois
Espera pela resposta	7 s	até 20 s
Tentativas	3, de 1 a 4 s entre elas	1 a cada 10 min, por até 5 dias

Fila por endereço, em ordem. Enquanto um aviso não é entregue, os seguintes esperam.
Responda 2xx logo e processe depois. Guarde o aviso e trate em segundo plano.
O mesmo aviso pode chegar mais de uma vez. Processe de forma idempotente.
Trocar o endereço não leva a fila junto. Os avisos antigos seguem tentando o endereço anterior até o fim das tentativas.
Quer garantia extra? Uma conciliação diária pela data de alteração pega o que tiver escapado.

O que foi enviado e o que o seu servidor respondeu, tentativa a tentativa, fica em Meus aplicativos › Webhooks › Entregas.

Tópicos

149 tópicos, por área.

Clientes e CRM18 tópicos

CRM.Conta.AlteradoCRM.Conta.ExcluidoCRM.Conta.IncluidoCRM.Contato.AlteradoCRM.Contato.ExcluidoCRM.Contato.IncluidoCRM.Oportunidade.AlteradoCRM.Oportunidade.ConcluidoCRM.Oportunidade.ExcluidoCRM.Oportunidade.FaturadoCRM.Oportunidade.IncluidoCRM.Oportunidade.StatusAlteradoCRM.Tarefa.AlteradaCRM.Tarefa.ExcluidaCRM.Tarefa.IncluidaClienteFornecedor.AlteradoClienteFornecedor.ExcluidoClienteFornecedor.Incluido

Vendas e notas21 tópicos

Frete.PedidoEntregueFrete.PedidoEnviadoFrete.SaiuParaEntregaFrete.StatusAtualizadoNFe.NotaAutorizadaNFe.NotaCanceladaNFe.NotaDevolucaoAutorizadaRemessaProduto.AlteradaRemessaProduto.CanceladaRemessaProduto.DevolvidaRemessaProduto.ExcluidaRemessaProduto.FaturadaRemessaProduto.IncluidaVendaProduto.AlteradaVendaProduto.CanceladaVendaProduto.DevolvidaVendaProduto.EncerradaVendaProduto.EtapaAlteradaVendaProduto.ExcluidaVendaProduto.FaturadaVendaProduto.Incluida

Serviços19 tópicos

ContratoServico.AlteradoContratoServico.AtivadoContratoServico.CanceladoContratoServico.ExcluidoContratoServico.FaturadoContratoServico.IncluidoContratoServico.SuspensoNFSe.NotaAutorizadaNFSe.NotaCanceladaNFSe.NotaSubstituidaOrdemServico.AlteradaOrdemServico.CanceladaOrdemServico.EtapaAlteradaOrdemServico.ExcluidaOrdemServico.FaturadaOrdemServico.IncluidaServico.AlteradoServico.ExcluidoServico.Incluido

Compras17 tópicos

CompraProduto.AlteradaCompraProduto.CanceladaCompraProduto.EncerradaCompraProduto.EtapaAlteradaCompraProduto.ExcluidaCompraProduto.IncluidaNotaEntrada.AlteradaNotaEntrada.CanceladaNotaEntrada.ConcluidaNotaEntrada.ExcluidaNotaEntrada.IncluidaRecebimentoProduto.AlteradoRecebimentoProduto.ConcluidoRecebimentoProduto.DevolvidoRecebimentoProduto.ExcluidoRecebimentoProduto.IncluidoRecebimentoProduto.Revertido

Finanças37 tópicos

Categoria.AlteradaCategoria.IncluidaDepartamento.AlteradoDepartamento.ExcluidoDepartamento.IncluidoFinancas.ContaCorrente.AlteradoFinancas.ContaCorrente.ExcluidoFinancas.ContaCorrente.IncluidoFinancas.ContaCorrente.Lancamento.AlteradoFinancas.ContaCorrente.Lancamento.ExcluidoFinancas.ContaCorrente.Lancamento.IncluidoFinancas.ContaCorrente.Transferencia.AlteradoFinancas.ContaCorrente.Transferencia.ExcluidoFinancas.ContaCorrente.Transferencia.IncluidoFinancas.ContaPagar.AlteradoFinancas.ContaPagar.BaixaCanceladaFinancas.ContaPagar.BaixaRealizadaFinancas.ContaPagar.ExcluidoFinancas.ContaPagar.IncluidoFinancas.ContaPagar.Rateio.CategoriaFinancas.ContaPagar.Rateio.DepartamentoFinancas.ContaReceber.AlteradoFinancas.ContaReceber.BaixaCanceladaFinancas.ContaReceber.BaixaRealizadaFinancas.ContaReceber.BoletoCanceladoFinancas.ContaReceber.BoletoGeradoFinancas.ContaReceber.ExcluidoFinancas.ContaReceber.IncluidoFinancas.ContaReceber.LinkCanceladoFinancas.ContaReceber.LinkGeradoFinancas.ContaReceber.PixCanceladoFinancas.ContaReceber.PixGeradoFinancas.ContaReceber.Rateio.CategoriaFinancas.ContaReceber.Rateio.DepartamentoProjeto.AlteradoProjeto.ExcluidoProjeto.Incluido

Produtos e estoque34 tópicos

CaracteristicaProduto.AlteradaCaracteristicaProduto.ExcluidaCaracteristicaProduto.IncluidaLocalEstoque.AlteradoLocalEstoque.DefinidoComoPadraoLocalEstoque.ExcluidoLocalEstoque.IncluidoOrdemProducao.AlteradaOrdemProducao.ConcluidaOrdemProducao.ExcluidaOrdemProducao.IncluidaOrdemProducao.RevertidaProduto.AjusteEstoqueProduto.AlteradoProduto.Alterado.marketplaceProduto.Alterado.pdvProduto.ExcluidoProduto.Excluido.marketplaceProduto.Excluido.pdvProduto.IncluidoProduto.Incluido.marketplaceProduto.Incluido.pdvProduto.MovimentacaoEstoqueProduto.MovimentacaoEstoque.marketplaceProduto.MovimentacaoEstoque.pdvRequisicaoProduto.AlteradaRequisicaoProduto.ExcluidaRequisicaoProduto.IncluidaTabelaPreco.AlteradaTabelaPreco.ExcluidaTabelaPreco.IncluidaTabelaPrecoItem.AlteradoTabelaPrecoItem.ExcluidoTabelaPrecoItem.Incluido

Cadastros3 tópicos

Vendedor.AlteradoVendedor.ExcluidoVendedor.Incluido