Alterar configuração webhook

📌 Endpoint

PUT /api/v2/avaliacao-saude/configuracao-web-hook/{id}

🌐 URLs dos Ambientes

🔹 Homologação

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

🔹 Produção

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

🔐 Autenticação

Este endpoint requer um token de autorização.

Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO

🔽 Cabeçalhos

Nome	Valor
accept	application/json
content-type	application/json

🔽 Parâmetros de Entrada

Nome	Tipo	Obrigatório	Local	Descrição
id	string	Sim	path	UUID da configuração

📝 Corpo da Requisição

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

Nome	Tipo	Obrigatório	Descrição
url	string	Não	URL do webhook
headers	array	Não	Lista de cabeçalhos personalizados (array de objetos com as propriedades chave e valor, ambos string)

| eventoAvaliacaoSaudeAprovada | boolean | Não | Notificar quando avaliação de saúde for aprovada | | eventoAvaliacaoSaudeAguardandoAprovacao | boolean | Não | Notificar quando avaliação de saúde após preenchimento (aguardando aprovação) | | eventoAvaliacaoSaudeArquivada | boolean | Não | Notificar quando avaliação de saúde for arquivada | | eventoAvaliacaoSaudeDesarquivada | boolean | Não | Notificar quando avaliação de saúde for desarquivada | | eventoPropostaCancelada | boolean | Não | Notificar quando proposta de uma vida for cancelada |

Exemplo de Corpo da Requisição

{
  "url": "https://webhook.exemplo.com/endpoint",
  "headers": [
    {
      "chave": "sua_chave",
      "valor": "seu_valor"
    }
  ],
  "eventoAvaliacaoSaudeAprovada": true,
  "eventoAvaliacaoSaudeAguardandoAprovacaoe,
  "eventoAvaliacaoSaudeArquivada": false,
  "eventoAvaliacaoSaudeDesarquivada": false,
  "eventoPropostaCancelada": true
}

🔄 Exemplo de Requisição

🔹 Ambiente de homologação

curl -X 'PUT' \
'https://integracao.hml.cloud.medsenior.com.br/api/v2/avaliacao-saude/configuracao-web-hook/UUID_DA_CONFIGURACAO' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' \
-d '{ ...corpo da requisição... }'

🔹 Ambiente de produção

curl -X 'PUT' \
'https://integracao.medsenior.com.br/api/v2/avaliacao-saude/configuracao-web-hook/UUID_DA_CONFIGURACAO' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' \
-d '{ ...corpo da requisição... }'

✅ 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,
  "eventoAvaliacaoSaudeAguardandoAprovacaoe,
  "eventoAvaliacaoSaudeArquivada": false,
  "eventoAvaliacaoSaudeDesarquivada": false,
  "eventoPropostaCancelada": true
}

❌ Códigos de Erro

Status Code	Significado	Descrição
400	Bad Request	Parâmetros inválidos ou ausentes.
401	Unauthorized	Falha na autenticação do token.
404	Not Found	Configuração não encontrada.
500	Server Error	Erro interno ao alterar a configuração.