Skip to main content

Set up a webhook

  • Updated

In addition to integrations that allow you to sync your repositories from Azure DevOps,  GitLab, or GitHub, Axify enables you to generate webhooks. This configuration aims to synchronize your code deployment data to Axify for more accuracy and feeds the DORA metrics.

It is possible to generate and link more than one webhook to the same Axify project, rename it, or revoke it.

Generate a webhook in Axify

  1. Access the desired project, then Project settings.

  2. Select the Integrations tab. This is where you'll find the integrations currently active and linked to this project.
    Screenshot 2023-10-27 at 11.30.44 AM.png

  3. In the Deployments section located at the bottom of the page, click on Generate webhook.
    Screenshot 2023-10-27 at 11.36.40 AM.png

     

  4. A modal will appear. Choose a deployment provider from the one presented.

    Screenshot 2023-10-27 at 11.40.59 AM.png

     

  5. Next, generate one or multiple webhooks for the selected provider while giving a name to each one if needed. In the example below Gitlab has been chosen as a provider.
    Screenshot 2023-10-27 at 11.49.34 AM.png
  6. Axify will automatically generate an URL (endpoint) and secret token for each webhook. Those are necessary to set up those webhooks in the corresponding provider. You can copy right away the requires information by clicking on Capture_d_e_cran__le_2022-04-11_a__11.05.15.pnglocated to the right of each piece of information, or do it later after finalizing the webhook configuration.

  7. As a last step, you will be able to configure environnements for your deployments. You will be able to map each individual environnement to two environnements tiers (Production or Staging). If none provided, Axify will provide you with a default mapping inspired by this article.
    Screenshot 2023-10-27 at 11.54.43 AM.png
  8. After finalizing the configuration, previously created webhooks will be listed in the Deployments section. You will able to copy the information from there to set up the webhook in the target provider. You will be able to update environnements mapping and/or generate other webhooks for the current project.
    Screenshot 2023-10-27 at 11.57.06 AM.png

Set up and configure a webhook in your tool-chain:

Axify supports several providers to be able to track deployments using webhook. To configure the webhook in your deployment tool, please follow one of the guide bellow corresponding to the provider that you are using.

Since deployment processes can vary from team to team, it is important to check the instructions above to ensure that your platform sends the type of event that can be received and interpreted by Axify.

If you need more details around webhook specifics for your platform, we invite you to consult the official documentation.

If needed, feel free to contact us to explore various options.

Change a webhook name:

  1. Under the Deployments section, locate the webhook to be renamed.
  2. Click on Axify_-_Logo_-_Crayon.png located on the right of the current name of the webhook to be renamed.
  3. Modify the webhook's name.
    1. To save your changes, click Axify_-_Logo_-_Checkmark.png.
    2. To cancel your changes, click Axify_-_Logo_-_X.png.
      Screenshot 2023-10-27 at 12.07.43 PM.png

Revoke a webhook:

  1. Under the Deployments section, locate the webhook to be revoked.
  2. Click on Revoke to the right of the options line for this webhook.
    Screenshot 2023-10-27 at 12.09.51 PM.png
  3. A confirmation window will appear. To confirm the revocation of the webhook, click on Yes, revoke.
    Screenshot 2023-10-27 at 12.10.57 PM.png
    Attention: This action cannot be undone. If a webhook is revoked, any deployment event received from that revoked webhook will be refused and an error response will be returned. However, all previous data will be maintained and will not be lost.

Related articles