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.

 

To 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.

    Capture_d_e_cran__le_2022-04-07_a__08.26.19.png

  3. In the Technical Axis section located at the bottom of the page, click on Generate webhook under Deployment.

    Capture_d_e_cran__le_2022-04-11_a__11.20.59.png

  4. A menu will display. Select the webhook to generate.

    EN_-_Webhooks_janvier_2023.png

  5. Axify will automatically generate the URL (endpoint) and secret token required to set up the webhook. You can now copy this information by clicking on Capture_d_e_cran__le_2022-04-11_a__11.05.15.pnglocated to the right of the required information, then continue the setup process in the selected software.

  6. Once the setup is complete, make sure to Set up your deployment environments in order to synchronize your data.

We invite you to consult the official documentation listed below for more information on the configuration process specific to some software.

Attention: Since the deployment process can vary from team to team, it is important to check the instructions below to ensure that your platform generates the type of event that can be received and interpreted by Axify. Otherwise, the data presented in the DORA metrics may be incorrect or even unavailable. If needed, feel free to contact us to explore various options.
  • Official GitLab documentation

    • Essentially, deployment events must be sent to the webhook to ensure proper connection. This means that when configuring in GitLab, you need to:

      • Check the Deployment Events checkbox.

      • Enable the SSL option.

      • And uncheck the Push option.

    • For the CI part, you need to use the GitLab deployment flow so that Axify can track the deployment events. You can refer to this official documentation for more details.

    • As of April 19, 2022, only deployments done in the production environment are counted.

  • Official GitHub documentation

    • As for GitLab, GitHub deployment events must be sent to the webhook. When configuring in GitHub, you must:

      • Enable JSON events (only events supported as of April 28, 2022)

      • Enable SSL verification.

      • Under "Which events would you like to trigger this webhook", select only Deployment statuses events.

      • Check the Active box at the bottom of the configuration page.

      • Click on Add webhook.

    • Note that in the Github documentation on webhook configuration, it is mentioned at the bottom of the page that a ping event is sent automatically upon creation. As of April 28, 2022, this ping automatically fails, but the deployment event works. This feature will be supported in a future release.

  • Official Microsoft documentation
    • There are some specific options to select when configuring the webhook for Azure DevOps. To begin, access the desired project in Azure DevOps.
    • In the lower-left corner, click on Project Settings, then on Service Hooks in the left-hand menu of the window that opens.
    • If there are no webhooks already generated, click the blue Create subscription button. If you already have webhooks, click on the green + at the top of the list.
    • In the menu that opens, select the webhooks option (at the bottom of the list), then click on next.
    • In the Trigger on this type of event menu, select the Release deployment completed type.
      • If desired, you can specify the name of the pipeline. Generally, the highest level of detail is preferred.
    • For the status, select Succeded, then click on Next.
      In the Settings section, under URL, paste the URL generated and copied from Axify.EN_-_Webhook_-_Copy_Azure_URL.png

      • The Basic authentication fields (username and password) are optional and can be left empty.
    • In the HTTP headers field, write X-Azure-Token: , then paste the secret token generated from Axify. The space after the : is optional.
      EN_-_Webhook_-_Copy_Azure_token.png
    • In the Messages to send field, select the None option. Make the same selection for the Detailed messages to send field.
    • In the Resource version field, select the 3.0 preview 1 option.
    • Click Finish.

To rename a webhook

  1. Follow the previous steps to access the integrations.
  2. Under the Deployment section, locate the webhook to be renamed.
  3. Click on Axify_-_Logo_-_Crayon.png located on the right of the current name of the webhook to be renamed.
  4. 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.

Rename_webhook_2023.png

To revoke a webhook

  1. Follow the previous steps to access the integrations.
  2. Under the Deployment section, locate the webhook to be revoked.
  3. Click on Revoke to the right of the options line for this webhook.
  4. A confirmation window will appear. To confirm the revocation of the webhook, click on Yes, revoke.
Attention: This action cannot be undone. If a webhook is revoked, deployment data synchronized from that source will be deleted from Axify and cannot be retroactively synchronized.

Related articles

Powered by Zendesk