Cadastrar e Atualizar Inscrição no Webhook

Endpoint público para cadastro e atualização de inscrição no Webhook por tópico

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
{
  "filtros": 
  {
    "contasOms": 
    [
      "Loja1",
      "Loja2"
    ],
    "idsStatus": 
    [
      "2"
    ],
    "contasOmsIgnorar": 
    [
      "Loja3"
    ],
    "contasPrincipaisOms":
    [
      "ContaPrincipal"
    ],
  },
  "inativo": true,
  "id": 9,
  "topico": "Pedido.Status",
  "url": "https://teste.com",
  "email": "[email protected]",
  "headers": 
  [
    {
      "chave": "Token",
      "valor": "abcs"
    }
  ],
  "observacao": "teste"
}

{
"topico": "Pedido.Status",
"empresa": "nome_empresa",
"contaOms": "conta",
"contaPrincipalOms": "conta_principal",
"cnpjContaOms": "12345678900",
"pedidoOms": "123456789",
"idsStatusPedidoOms": [1, 2, 3],
"dataHora": "datahora"
}
//JSON de exemplo da notificação do Webhook

🔁 Política de Tentativas de Webhook

Em caso de falha no envio do Webhook, o sistema realiza até 10 tentativas de reenvio, seguindo um modelo de tempo de intervalo exponencial. A cada nova falha, o tempo de espera entre as tentativas aumenta, conforme listagem abaixo:

1º Erro - 2 minutos
2º Erro - 5 minutos
3º Erro - 15 minutos
4º Erro - 30 minutos
5º Erro - 1 hora
6º Erro - 2 horas
7º Erro - 3 horas
8º Erro - 5 horas
9º Erro - 24 horas
10º Erro - 48 horas

⚠️ Importante: Após a décima tentativa falha, a inscrição do Webhook será automaticamente desativada.


⚠️ Importante: A respeito do campo "tópico" que será citado a seguir, ele deve ser preenchido com "PEDIDO.STATUS". Esse é o único tópico disponível.


Body Params
int32

Id gerado ao se inscrever em um tópico. Para inclusão, enviar o valor null, para atualização, enviar o Id que deseja atualizar.

string

Tópico ao qual está se inscrevendo.

string
required

URL da API e endpoint que o Webhook irá notificar.

filtros
object

Filtro possíveis

headers
array of objects

Header que será enviado no request, composto por chave e valor. Caso não precise, enviar null

headers
string

E-mail que será usado para disparar aviso caso uma conta seja inativada por limite de tentativas

string

campo onde é possível guardar informações sobre o motivo da inscrição no tópico

boolean
Defaults to false

Status da inscrição.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json