Pular para o conteúdo principal

Criar configuração de webhook

📌 Endpoint

POST /api/v2/avaliacao-saude/configuracao-web-hook

🌐 URLs dos Ambientes

🔹 Homologação

https://integracao.hml.cloud.medsenior.com.br/api/v2/avaliacao-saude/configuracao-web-hook

🔹 Produção

https://integracao.medsenior.com.br/api/v2/avaliacao-saude/configuracao-web-hook

🔐 Autenticação

Este endpoint requer um token de autorização.

Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO

🔽 Cabeçalhos

NomeValor
acceptapplication/json
content-typeapplication/json

📝 Corpo da Requisição

O corpo da requisição deve ser enviado em JSON e conter os seguintes campos:

NomeTipoObrigatórioDescrição
urlstringSimURL do webhook
headersarrayNãoLista de cabeçalhos personalizados (array de objetos com as propriedades chave e valor, ambos string)
eventoAvaliacaoSaudeAprovadabooleanNãoNotificar quando avaliação de saúde for aprovada
eventoAvaliacaoSaudeAguardandoAprovacaobooleanNãoNotificar quando avaliação de saúde após preenchimento (aguardando aprovação)
eventoAvaliacaoSaudeArquivadabooleanNãoNotificar quando avaliação de saúde for arquivada
eventoAvaliacaoSaudeDesarquivadabooleanNãoNotificar quando avaliação de saúde for desarquivada
eventoPropostaCanceladabooleanNãoNotificar quando proposta de uma vida for cancelada

Exemplo de Corpo da Requisição

{
"url": "https://webhook.site/your-webhook-url",
"headers": [
{
"chave": "sua_chave",
"valor": "seu_valor"
}
],
"eventoAvaliacaoSaudeAprovada": true,
"eventoAvaliacaoSaudeAguardandoAprovacao": false,
"eventoAvaliacaoSaudeArquivada": false,
"eventoAvaliacaoSaudeDesarquivada": false
}

🔄 Exemplo de Requisição

🔹 Ambiente de homologação

curl -X 'POST' \
'https://integracao.hml.cloud.medsenior.com.br/api/v2/avaliacao-saude/configuracao-web-hook' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' \
-d '{
"url": "https://webhook.site/your-webhook-url",
"headers": [
{
"chave": "Authorization",
"valor": "Bearer seu_token"
}
],
"eventoAvaliacaoSaudeAprovada": true,
"eventoAvaliacaoSaudeAguardandoAprovacao": false,
"eventoAvaliacaoSaudeArquivada": false,
"eventoAvaliacaoSaudeDesarquivada": false,
"eventoPropostaCancelada": true
}'

🔹 Ambiente de produção

curl -X 'POST' \
'https://integracao.medsenior.com.br/api/v2/avaliacao-saude/configuracao-web-hook' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' \
-d '{
"url": "https://webhook.site/your-webhook-url",
"headers": [
{
"chave": "Authorization",
"valor": "Bearer seu_token"
}
],
"eventoAvaliacaoSaudeAprovada": true,
"eventoAvaliacaoSaudeAguardandoAprovacao": false,
"eventoAvaliacaoSaudeArquivada": false,
"eventoAvaliacaoSaudeDesarquivada": false,
"eventoPropostaCancelada": true
}'

✅ Resposta de Sucesso

  • Status Code: 200 OK

Exemplo de Resposta

{
"id": "b1e7f7e2-7e6e-4b8c-9e2e-123456789abc",
"usuarioId": "string (uuid)",
"sistemaOrigem": 0,
"url": "https://webhook.exemplo.com/endpoint",
"clientId": "string | null",
"headers": [
{
"chave": "sua_chave",
"valor": "seu_valor"
}
],
"eventoAvaliacaoSaudeAprovada": true,
"eventoAvaliacaoSaudeAguardandoAprovacao": false,
"eventoAvaliacaoSaudeArquivada": false,
"eventoAvaliacaoSaudeDesarquivada": false,
"eventoPropostaCancelada": true
}

❌ Códigos de Erro

Status CodeSignificadoDescrição
400Bad RequestParâmetros inválidos ou ausentes.
401UnauthorizedFalha na autenticação do token.
500Server ErrorErro interno ao criar a configuração do webhook.