Saltar para o conteúdo
Referência da API
/
Recursos Compartilhados
/
/Webhooks

Webhooks

APIs para a configuração do webhook da equipe.

Operations

Configurar o webhook da equipe

Request

Cria ou substitui a configuração de webhook da equipe.

  • Pré-requisitos: callbackUrl deve ser uma URL HTTPS de 1 a 1024 caracteres, com host, sem informações de usuário, sem fragmento e com porta válida. Todos os endereços para os quais ela resolver precisam ser roteáveis publicamente; faixas de localhost, privadas, link-local, CGNAT, metadados de nuvem, reservadas por protocolo, de documentação e 6to4 são rejeitadas. A mesma verificação ocorre de novo quando uma entrega abre a conexão, então um nome que depois resolva para uma faixa privada faz aquela entrega falhar em vez de alcançar sua rede.
  • Efeito: faz upsert da única configuração da equipe do contexto do servidor. teamId nunca é lido da requisição, então quem chama não pode configurar outra equipe. Os endpoints da Local API e da Open API leem e gravam o mesmo registro, e a resposta reflete o que foi armazenado.
  • Desativação: enabled: false mantém a URL e interrompe a criação de novos eventos. Eventos já na fila são cancelados um a um se a configuração ainda estiver desativada quando forem autorizados, então reativar logo permite que continuem.
  • Repetição: seguro. O salvamento é um upsert por equipe, então repetir a mesma requisição converge para o mesmo estado.
  • Versão do cliente: requer o cliente MoreLogin v2.66.0 ou superior, porque é o cliente de desktop que expõe essa rota localmente. O endpoint da Open API não depende do cliente.

Consulte Webhooks para o contrato de callback, os nomes de evento e a programação de novas tentativas.

Erros de negócio documentados: 41001. Consulte Error Codes para o significado de cada código. Qualquer operação também pode retornar os códigos comuns.

Bodyapplication/json
callbackUrlstring, <= 1024 charactersrequired

URL HTTPS que recebe os eventos. De 1 a 1024 caracteres.

enabledbooleanrequired

Indica se a entrega está ativada para a equipe.

POST
/api/webhook/config
curl -i -X POST \
  http://127.0.0.1:40000/api/webhook/config \
  -H 'Content-Type: application/json' \
  -d '{
    "callbackUrl": "https://example.com/morelogin/webhook",
    "enabled": true
  }'

Responses

Sucesso. data é um objeto com os campos callbackUrl e enabled, refletindo a configuração armazenada.

Headers
any
Bodyapplication/json
codeintegerrequired

Código de resultado. 0 indica sucesso; outros códigos indicam exceções.

msgstring or nullrequired

Mensagem de erro

dataobjectrequired
requestIdstringrequired

ID da solicitação da operação

Response
{
  "code": 0,
  "msg": "",
  "data": {
    "callbackUrl": "https://example.com/morelogin/webhook",
    "enabled": true
  },
  "requestId": ""
}