Source Providers - List Webhooks
Gets a list of webhooks installed in the given source code repository.
GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/webhooks?api-version=7.1
GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/webhooks?serviceEndpointId={serviceEndpointId}&repository={repository}&api-version=7.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
project
|
path | True |
string |
Project ID or project name |
provider
|
path | True |
string |
The name of the source provider. |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.1' to use this version of the api. |
repository
|
query |
string |
If specified, the vendor-specific identifier or the name of the repository to get webhooks. Can only be omitted for providers that do not support multiple repositories. |
|
service
|
query |
string (uuid) |
If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Name | Description |
---|---|
vso.build | Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to receive notifications about build events via service hooks. |
Definitions
Name | Description |
---|---|
Definition |
The type of the trigger. |
Repository |
Represents a repository's webhook returned from a source provider. |
DefinitionTriggerType
The type of the trigger.
Value | Description |
---|---|
all |
All types. |
batchedContinuousIntegration |
A build should be started for multiple changesets at a time at a specified interval. |
batchedGatedCheckIn |
A validation build should be started for each batch of check-ins. |
buildCompletion |
A build should be triggered when another build completes. |
continuousIntegration |
A build should be started for each changeset. |
gatedCheckIn |
A validation build should be started for each check-in. |
none |
Manual builds only. |
pullRequest |
A build should be triggered when a GitHub pull request is created or updated. Added in resource version 3 |
schedule |
A build should be started on a specified schedule whether or not changesets exist. |
RepositoryWebhook
Represents a repository's webhook returned from a source provider.
Name | Type | Description |
---|---|---|
name |
string |
The friendly name of the repository. |
types | ||
url |
string |
The URL of the repository. |