API & webhook settings
Esta ferramenta está disponível para todos os usuários em todos os planos de assinatura.
Clockify allows you to manage and configure advanced settings for your profile such as webhooks e API keys. This way get more control over your account’s security and efficiency.
API keys #
É importante salvar suas chaves de API em um local seguro. Se você perder uma chave ou não salvá-la, gerar uma nova desativará a chave antiga, o que pode prejudicar configurações e integrações existentes.
No Clockify, você pode salvar suas chaves de API e editá-las conforme necessário.
Encontre as configurações da sua chave de API na guia Avançado das suas Configurações de perfil.
Clique no botão Gerenciar chaves de API e veja uma lista de todas as APIs que você gerou na página que se abre.
Aqui, você pode gerenciar suas chaves de API de algumas maneiras diferentes.
Gerar chave de API
Para criar uma nova chave:
- Clique em Gerar novo no canto superior direito da página
- A janela Gerar chave de API é aberta
- Digite um nome para sua nova chave de API
Dê um nome descritivo para que você saiba para que serve. - Clique em Gerar
Sua nova chave será criada automaticamente e adicionada à lista na página Gerenciar chaves de API.
Editar chave de API
Se você precisar fazer algumas alterações na chave de API:
- Clique no menu de três pontos ao lado da chave de API que você deseja desabilitar
- Escolha a opção Renomear/Excluir
- Digite o novo nome ou clique em Excluir para confirmar a ação
O novo nome da chave de API é atualizado automaticamente na página Gerenciar chaves de API.
Após ser excluída, essa chave de API não pode mais ser usada e é automaticamente removida da página Gerenciar chaves de API e da guia Contas nas Configurações do espaço de trabalho.
Webhooks #
Crie webhooks para receber notificações e atualizações de dados em tempo real.
Esta funcionalidade está disponível para proprietários e administradores de espaços de trabalho. A seção Webhooks não é visível para outras funções de usuário.
Siga estes passos:
- Vá para a página Preferências
- Selecione a guia Avançado
- Na seção Webhooks, clique em Gerenciar webhooks
- Você será redirecionado para a página Webhooks
Se você faz parte de vários espaços de trabalho, escolha o espaço de trabalho relevante.
Para criar um novo webhook:
- Clique no botão Criar novo no canto superior direito
- In the Create webhook window, provide the following details:
Name: Specify a name for your webhook
Endpoint: Enter the webhook’s endpoint URL
Event: Choose the event that will trigger the webhook - Clique em Criar para concluir o processo
Se você faz parte de vários espaços de trabalho, escolha o espaço de trabalho relevante.
Os eventos de webhook criados são classificados em ordem alfabética.
O evento do webhook pode ser desabilitado durante a criação, caso o espaço de trabalho do Clockify não esteja no plano de assinatura que oferece suporte a esse recurso.
Detalhes do webhook #
Se quiser ver os detalhes do webhook, você pode fazer isso abrindo o menu de três pontos desse webhook.
- Vá para o webhook que você gostaria de examinar
- Abra Detalhes no menu de três pontos
- Uma nova página é aberta com a lista de tentativas de webhook
Aqui, você pode ver o horário da tentativa e o status do evento.
Dica: O tempo de tentativa segue o formato definido nas preferências.
O webhook de teste também pode ser exibido nas tentativas de webhook com o status e a carga útil apropriados.
Editar webhook #
Se você quiser modificar quaisquer dados relacionados aos webhooks, você pode fazer isso escolhendo a opção de edição.
- Vá para o webhook que você gostaria de editar
- Abra Editar no menu de três pontos
- Uma nova página é aberta com a lista de tentativas de webhook
Aqui você pode modificar todos os elementos do webhook criado:
- Alterar nome do webhook
- Alterar URL do ponto de extremidade
- Selecione outro evento no menu suspenso
- Alterar (redefinir) Segredo de assinatura
Excluir webhook #
Se você quiser excluir um webhook que está obsoleto ou que não está mais usando, você pode fazer isso da seguinte maneira:
- Vá para o webhook que você gostaria de editar
- Selecione Excluir no menu de três pontos
- Clique em Excluir na janela de confirmação
Webhooks do Marketplace #
Usuários de complementos não têm um botão Reenviar nas tentativas de webhook de complementos.