v1

latestOpenAPI 3.1.02026-08-044330906.8 KB

Cadastrar e Atualizar Inscrição no Webhook

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

post/configuracoes/topico-webhook

Request body

idinteger

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.

topicostring

Tópico ao qual está se inscrevendo.

urlstring required

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

emailstring

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

observacaostring

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

inativoboolean

Status da inscrição.

Response

200

mensagemstring

{"stackTrail":"paths:/configuracoes/topico-webhook:post:responses:200:content:application/json:schema:properties:dados","oasType":"schema","type":"unknown"}

Example response

{
  "mensagem": "Sucesso"
}