Foundational

Accessing source code in Azure Repos is what allows Foundational to accurately determine data lineage and analyze pending and historical pull requests.

In order to configure Azure Repos, you will need the following steps:

Configure Foundational Azure Repos Connector

1. Configure a Personal Access Token
2. Configure Foundational Azure Repos Connector
3. Configure Web Hooks

Step #1: Configure a Personal Access Token (PAT)

Create a Personal Access Token (PAT) in your Azure account by following the steps in this link: <a href="https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&amp;tabs=Windows#create-a-pat" rel="nofollow noopener noreferrer" target="_blank">Create PAT</a>.

Choose the following scopes when configuring the PAT:

1. Code : Read &amp; Write
2. Code : Status
3. Project and Team : Read
4. Pull Request Threads : Read &amp; Write
5. User Profiles : Read
6. Identity : Read

1. Choose a specific organization.
2. One year expiration is recommended.
3. Choose the following scopes when configuring the PAT:
   1. Code : Read &amp; Write
   2. Code : Status
   3. Project and Team : Read
   4. Pull Request Threads : Read &amp; Write
   5. User Profiles : Read
   6. Identity : Read

Consider creating a special Azure user for Foundational: The owner of this PAT will appear as an author of all Foundational Pull Request comments.

Step #2: Configure Azure Repos Connector 

Go to Foundational's <a href="https://app.foundational.io/connectors" rel="nofollow noopener noreferrer" target="_blank">Integrations</a> page.

Enter Organization Name as it appears in Azure Repos UI.

Choose a strong password and enter it under Webhook Password.

1. (Store it, you will need it in the future)

1. Go to Foundational's <a href="https://app.foundational.io/connectors" rel="nofollow noopener noreferrer" target="_blank">Integrations</a> page.
2. Click on Azure Repos.
3. Click Add new Azure Repos connection.
4. Enter Organization Name as it appears in Azure Repos UI.
5. Enter the Personal Access Token.
6. Choose a strong password and enter it under Webhook Password.
 1. (Store it, you will need it in the future)
7. Click Save.

The Web Hooks notify Foundational on certain events, such as new merge requests, new commits to existing merge requests, etc.

Create five Web Hooks for each of the projects that you would like to integrate with Foundational by following these <a href="https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks" rel="nofollow noopener noreferrer" target="_blank">steps</a>, or by running the script below.

Choose those triggers for different Web Hooks:

1. Code pushed
2. Pull request created
3. Pull request updated
4. Pull request merge attempted
5. Repository created

Use the this value for URL (ORG_NAME is an Organization Name as it appears in Azure Repos UI): <code>https://hooks.foundational.io/api/v1/azure_repos_webhook?id_=ORG_NAME</code>

Use this value for basic authentication username: <code>foundational-webhook</code>

Use the Webhook Password from above for basic authentication password

1. Create five Web Hooks for each of the projects that you would like to integrate with Foundational by following these <a href="https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks" rel="nofollow noopener noreferrer" target="_blank">steps</a>, or by running the script below.
2. Choose those triggers for different Web Hooks:
 1. Code pushed
 2. Pull request created
 3. Pull request updated
 4. Pull request merge attempted
 5. Repository created
3. Use the this value for URL (ORG_NAME is an Organization Name as it appears in Azure Repos UI): <code>https://hooks.foundational.io/api/v1/azure_repos_webhook?id_=ORG_NAME</code>
4. Use this value for basic authentication username: <code>foundational-webhook</code>
5. Use the Webhook Password from above for basic authentication password

If you would like to automate Web Hooks creation, please use this script and substitute the values in double curly braces:

The executing user must be in <code>Project Collection Administrators</code> group for this command to succeed.

Run this script five times per project which you would like to onboard with the following values for <code>{{EVENT_TYPE}}</code> :

1. <code>git.repo.created</code>
2. <code>git.push</code>
3. <code>git.pullrequest.created</code>
4. <code>git.pullrequest.updated</code>
5. <code>git.pullrequest.merged</code>

1. The executing user must be in <code>Project Collection Administrators</code> group for this command to succeed.
2. Run this script five times per project which you would like to onboard with the following values for <code>{{EVENT_TYPE}}</code> :
 1. <code>git.repo.created</code>
 2. <code>git.push</code>
 3. <code>git.pullrequest.created</code>
 4. <code>git.pullrequest.updated</code>
 5. <code>git.pullrequest.merged</code>

curl -u :{{PERSONAL_ACCESS_TOKEN}} --request POST \ -H "Content-Type: application/json" \ --data '{ "publisherId": "tfs", "eventType": "{{EVENT_TYPE}}", "resourceVersion": "1.0", "consumerId": "webHooks", "consumerActionId": "httpRequest", "publisherInputs": { "projectId": "{{PROJECT_UUID}}" }, "consumerInputs": { "url": "https://hooks.foundational.io/api/v1/azure_repos_webhook?id_={{ORG_NAME}}", "basicAuthUsername": "foundational-webhook", "basicAuthPassword": "{{WEBHOOK_PASSWORD}}", "resourceDetailsToSend": "all" } }' \ "https://dev.azure.com/{{ORG_NAME}}/_apis/hooks/subscriptions?api-version=7.1"

How to set up Azure Repos

Find answers and get help from Intercom Support and Community Experts

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Link, Press control-option-right-arrow to exit

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

How to set up Azure Repos

Step #1: Configure a Personal Access Token (PAT)

Step #2: Configure Azure Repos Connector

Step #3: Configure Web Hooks

Manual configuration

Scripted configuration