POST api/v1/webhook/novo

Descrição

Cadastra a url de webhook. Veja a documentação completa de Webhooks.
Obs.: Utilizar tokenAPI (Authorization: Bearer)

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

Parâmetros de Entrada

Campo	Descrição	Tipo	Tamanho	Obrigatório
url	url de recebimento do webhook.	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	Modulo do webhook aceito os termos: webhook ou fila. Webhook: Quando um evento ocorrer no allPost, enviaremos uma notificação para seu sistema. Fila: Quando um evento ocorrer adicionaremos na fila para que seu sistema possa consumir.	string	7	não - valor padrão webhook
rastreio	Para receber registrar webhooks sobre ocoren do pedido: em trânsito, ocorrências, saiu para entrega e entrega realizada.	bolean		não - valor padrão true
prazoAdicional	Para receber registrar webhooks sobre alteração nos prazos adicionais.	bolean		não - valor padrão true
aplicativo	Para receber registrar webhooks evento de desinstalação do aplicativo: delete.	bolean		não - valor padrão true
metodoEnvio	Para receber registrar webhooks Evento método envio: novo\|altera\|delete	bolean		não - valor padrão true
rastreioEnventos	Para receber registrar webhooks sobre eventos dos rastreios: Saida da unidade, Chegada na unidade, etc.	bolean		não - valor padrão true

Parâmetros de Retorno

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

Body

{
    "url": "",
    "tipoAutorizacao": "",
    "usuario": "",
    "senha": "",
    "token": "",
    "modulo": "webhook",
    "rastreio": true,
    "prazoAdicional": true,
    "aplicativo": true,
    "metodoEnvio": true,
    "rastreioEnventos": true
}

Response

{
    "mensagem": "sucesso"
}