Configure a webhook in Visual Studio GIT Enterprise
A. Create a Webhook API token from ARM
Log in to ARM.
Click on Admin Section -> API Token.
Click on Create API Token.
Enter the token name.
Select Type as âwebhook.â
Enter Description if required.
Click on Create Option.
Your New API Token is created.
B. Create a webhook with authentication on Visual Studio Git
Log in to Microsoft Visual Studio Git Account
Go to your project Service Hooks page:
https://{orgName}/{projectname}/settings/serviceHooks |
Click on Create Subscription.
The wizard will start and give a list of all the services for which integration is to be created.
Click on Next and you will see a list of triggers when an event occurs. Select the event to initiate the trigger on and any filters (if applicable):
The next step is to provide the payload URL. The payload URL is the URL of the server that will receive the webhook POST requests. Paste the copied URL generated by AutoRABIT or enter the payload URL manually. Payload URL: < instance_url>/api/webhook/v2/<orgname>/trigger-scm-push-request For example: If the instance is https://login.autorabit.com, then the payload URL would be: https://login.autorabit.com/autorabitrest/webhook/triggerSCMPushrequest.
Add the basic authentication details as shown below. Basic authentication username: ARM login username. Basic authentication password: Webhook type API token generated from ARM.
Enter the Username used in AutoRABIT and password as webhook API Token generated in ARM.
Confirm the settings are correct, test the subscription, and then finish the wizard.
Click on the Finish button to complete the service hook subscription. The webhook can be seen in the Service Hooks tab.
Once the build is triggered via webhook and completed successfully, refresh the service hook tab to verify that the webhook succeeded. You can also view the history of webhooks to see how many times the event was triggered and whether the webhook was completed successfully.
Smart Commits
In this section, you can select the pattern used to read the comment in a revision associated with your ALM story. For example, 'git commit m [project123] # add README file into the project'.
If you want to configure a webhook in your repository, select the Enable auto update on webhook checkbox to reveal the URL required for the webhook settings. For more information on how to configure a webhook in different repositories, refer HERE. You can also choose to sync external smart commits.
For Enterprise customers
/api/webhook/v2/<orgname>/enterprise/trigger-scm-push-request
/api/webhook/v2/<orgname>/enterprise/sync-alm-commits
Last updated
