POST api/v1/webhook/novo

Descrição

Cadastra a url de webhook.
Obs.: Utilizar tokenAPI (Authorization: Bearer)

É aceito apenas uma url. Para alterar os dados do webhook basta efetuar novo POST.

Body da Requisição

{
    "url": "",
    "tipoAutorizacao": "",
    "usuario": "",
    "senha": "",
    "token": "",
    "modulo": "webhook",
    "aplicativo": true,
    "atendimentoCriado": true,
    "atendimentoMensagem": true,
    "atendimentoEncerrado": true
}

Parâmetros de Entrada

Campo	Descrição	Tipo	Tamanho	Obrigatório
url	URL de recebimento do webhook (apenas HTTPS).	string	500	sim
tipoAutorizacao	Utilizar Basic ou Bearer	string	20	não
usuario	Nome do usuário quando tipoAutorizacao for Basic	string	30	sim se tipoAutorizacao Basic
senha	Senha quando tipoAutorizacao for Basic	string	100	sim se tipoAutorizacao Basic
token	Token quando tipoAutorizacao for Bearer	string	100	sim se tipoAutorizacao Bearer
modulo	Módulo do webhook aceito os termos: webhook ou fila. Webhook: Quando um evento ocorrer no HelpyGo, enviaremos uma notificação para seu sistema. Fila: Quando um evento ocorrer adicionaremos na fila para que seu sistema possa consumir via API.	string	7	não - valor padrão webhook
aplicativo	Receber webhooks de eventos do aplicativo: desinstalação (delete).	boolean		não - valor padrão true
atendimentoCriado	Receber webhooks quando um novo atendimento SAC é criado.	boolean		não - valor padrão true
atendimentoMensagem	Receber webhooks quando um atendimento SAC recebe uma nova mensagem (interação).	boolean		não - valor padrão true
atendimentoEncerrado	Receber webhooks quando um atendimento SAC é encerrado.	boolean		não - valor padrão true

Parâmetros de Retorno

Campo	Descrição	Tipo	Tamanho
mensagem	mensagem de sucesso ou erro	string	255

Exemplo de Resposta

{
    "mensagem": "sucesso"
}