Administration

Clockify centre d’aide Administration Paramètres API et webhook

Paramètres API et webhook

5 min de lecture
Who can use this feature?
All users (API); Workspace owners and admins (Webhook settings)
Free and paid plans

Clockify vous permet de gérer et de configurer les paramètres avancés de votre profil, tels que les webhooks et les clés API. Vous bénéficiez ainsi d’un meilleur contrôle sur la sécurité et l’efficacité de votre compte.

API keys #

Il est important de conserver vos clés d’API dans un endroit sûr. Si vous perdez une clé, ou si vous ne la sauvegardez pas, la génération d’une nouvelle clé désactivera l’ancienne clé, ce qui risque d’interrompre les configurations et les intégrations existantes.
Dans Clockify, vous pouvez sauvegarder vos clés API et les modifier si nécessaire.

Les paramètres de votre clé API se trouvent dans l’onglet Avancé dans la section Paramètres de profil.

Cliquez sur le bouton Gérer les clés API et vous verrez une liste de toutes les API que vous avez générées sur la page qui s’ouvre. 

Ici, vous pouvez gérer vos clés API de différentes manières. 

Générer une clé API #

Pour créer une nouvelle clé :

  1. Cliquez sur Générer une nouvelle clé dans le coin supérieur droit de la page
  2. La fenêtre Générer une clé API s'ouvre 
  3. Saisissez un nom pour votre nouvelle clé API
    Donnez un nom descriptif, afin que vous sachiez à quoi elle sert. 
  4. Click Generate

Votre nouvelle clé sera automatiquement créée et ajoutée à la liste de la page Gérer les clés API.

Modifier la clé API #

Si vous devez apporter des modifications à la clé API, cliquez sur le menu à trois points situé à côté de la clé API que vous souhaitez désactiver :

  1. Cliquez sur le menu à trois points situé à côté de la clé API que vous souhaitez désactiver
  2. Choisissez l’option Renommer/Supprimer
  3. Saisissez le nouveau nom ou cliquez sur Supprimer pour confirmer l’action

Le nom de la nouvelle clé API est automatiquement mis à jour sur la page Gérer les clés API. Après avoir été supprimée, cette clé API ne peut plus être utilisée et est automatiquement supprimée de la page Gérer les clés API et de l’onglet Comptes dans les Paramètres de l’espace de travail.

Webhooks #

Remarque

This feature is available to Workspace owners and admins. The webhooks section is not visible to other user roles.

Créez des webhooks pour recevoir des notifications et des mises à jour de données en temps réel.

Suivez les étapes suivantes :

  1. Allez dans Préférences
  2. Sélectionnez l'onglet Avancé
  3. Dans la section Webhooks cliquez sur Gérer les webhooks
  4. Vous serez redirigé vers la page Webhooks

Si vous faites partie de plusieurs espaces de travail, choisissez l’espace de travail approprié.

Pour créer un nouveau webhook :

  1. Cliquez sur le bouton Créer un nouveau en haut à droite
  2. Dans la fenêtre Créer un webhook, fournissez les informations suivantes :

    Nom : Spécifiez un nom pour votre webhook
    Point de terminaison : Entrez l’URL du point de terminaison du webhook
    Événement : Choisissez l’événement qui déclenchera le webhook
  3. Click on Create to complete the process

Si vous faites partie de plusieurs espaces de travail, choisissez l’espace de travail approprié.

Les événements webhook créés sont classés par ordre alphabétique. 

Remarque

The webhook event can be disabled while created, if Clockify workspace is not on the subscription plan that supports this feature.  

Détails du webhook #

Si vous souhaitez consulter les détails d’un webhook, vous pouvez le faire en ouvrant le menu à trois points de ce webhook. 

  • Accédez au webhook que vous souhaitez examiner
  • Ouvrez les détails dans le menu à trois points 
  •  Une nouvelle page s’ouvre avec la liste des tentatives de Webhook 

Ici, vous pouvez voir l’heure de la tentative et le statut de l’événement. 

Remarque

Attempt time follows the format set in the preferences.

Le webhook de test peut également être affiché dans les tentatives de webhook avec le statut et la charge utile appropriés. 

Webhook retry mechanism #

Clockify uses an automated retry mechanism to handle temporary outage or endpoint issues. 

If your domain is unavailable, the system will automatically retry sending the webhook up to 4 times over a 72-hour period: 

  • Retry 1: 12 seconds after the failure
  • Retry 2: 10 minutes later
  • Retry 3: 30 minutes later
  • Retry 4: 72 hours later (for long-term outage)
Info

Only 2xx HTTP responses are marked as Succeeded. Timed-out or non-2xx responses are marked as Failed or Retrying.

You can click Resend on any webhook attempt, regardless of its current status. If the manual resend is successful, the status will be updated to Succeeded.

There is a color-coding to your Preferences tab to help you track statuses at a glance: 

  • Webhook status: Active, Disabled
  • Attempt status: Succeeded, Retrying, Failed 

Modifier le webhook #

Si vous souhaitez modifier des données relatives aux webhooks, vous pouvez le faire en sélectionnant l’option de modification.

  • Accédez au webhook que vous souhaitez modifier
  • Ouvrez Modifier dans le menu à trois points 
  •  Une nouvelle page s’ouvre avec la liste des tentatives de Webhook 

Ici, vous pouvez modifier tous les éléments du webhook créé : 

  • Modifier le nom du webhook
  • Modifier l’URL du point de terminaison
  • Choisir un autre événement dans le menu déroulant
  • Modifier (réinitialiser) le secret de signature 

Supprimer le webhook #

Si vous souhaitez supprimer un webhook que vous n’utilisez plus, vous pouvez le faire de la manière suivante : 

  • Accédez au webhook que vous souhaitez modifier
  • Sélectionnez Supprimer dans le menu à trois points 
  • Cliquez sur Supprimer dans la fenêtre de confirmation

Webhooks du Marketplace #

In the Clockify marketplace, add-on users don’t have a Resend button in add-on webhook attempts.

Cet article vous a-t-il été utile ? #

Thank you! If you’d like a member of our support team to respond to you, please drop us a note at support@clockify.me