Subscriptions - Create Subscriptions Query

  • Reference
Service:
Service Hooks
API Version:
7.1

Query for service hook subscriptions.

POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=7.1

URI Parameters

Name In Required Type Description
organization
 path True

string

The name of the Azure DevOps organization.
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.

Request Body

Name Type Description
consumerActionId

string

Optional consumer action id to restrict the results to (null for any)
consumerId

string

Optional consumer id to restrict the results to (null for any)
consumerInputFilters

InputFilter[]

Filter for subscription consumer inputs
eventType

string

Optional event type id to restrict the results to (null for any)
publisherId

string

Optional publisher id to restrict the results to (null for any)
publisherInputFilters

InputFilter[]

Filter for subscription publisher inputs
results

Subscription[]

Results from the query
subscriberId

string

Optional subscriber filter.

Responses

Name Type Description
200 OK

SubscriptionsQuery

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.work Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.
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.
vso.code Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks.

Definitions

Name Description
IdentityRef
InputFilter

Defines a filter for subscription inputs. The filter matches a set of inputs if any (one or more) of the groups evaluates to true.
InputFilterCondition

An expression which can be applied to filter a list of subscription inputs
InputFilterOperator

The operator applied between the expected and actual input value
ReferenceLinks

The class to represent a collection of REST reference links.
Subscription

Encapsulates an event subscription.
SubscriptionsQuery

Defines a query for service hook subscriptions.
SubscriptionStatus

IdentityRef

Name Type Description
_links

ReferenceLinks

This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor

string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias

string

Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName

string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id

string

imageUrl

string

Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive

boolean

Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName

string

Deprecated - use Domain+PrincipalName instead
url

string

This url is the full route to the source resource of this graph subject.

InputFilter

Defines a filter for subscription inputs. The filter matches a set of inputs if any (one or more) of the groups evaluates to true.

Name Type Description
conditions

InputFilterCondition[]

Groups of input filter expressions. This filter matches a set of inputs if any (one or more) of the groups evaluates to true.

InputFilterCondition

An expression which can be applied to filter a list of subscription inputs

Name Type Description
caseSensitive

boolean

Whether or not to do a case sensitive match
inputId

string

The Id of the input to filter on
inputValue

string

The "expected" input value to compare with the actual input value
operator

InputFilterOperator

The operator applied between the expected and actual input value

InputFilterOperator

The operator applied between the expected and actual input value

Name Type Description
equals

string

notEquals

string

The class to represent a collection of REST reference links.

Name Type Description
links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

Subscription

Encapsulates an event subscription.

Name Type Description
_links

ReferenceLinks

Reference Links
actionDescription

string

consumerActionId

string

consumerId

string

consumerInputs

object

Consumer input values
createdBy

IdentityRef

createdDate

string

eventDescription

string

eventType

string

id

string

lastProbationRetryDate

string

modifiedBy

IdentityRef

modifiedDate

string

probationRetries

string

publisherId

string

publisherInputs

object

Publisher input values
resourceVersion

string

status

SubscriptionStatus

subscriber

IdentityRef

url

string

SubscriptionsQuery

Defines a query for service hook subscriptions.

Name Type Description
consumerActionId

string

Optional consumer action id to restrict the results to (null for any)
consumerId

string

Optional consumer id to restrict the results to (null for any)
consumerInputFilters

InputFilter[]

Filter for subscription consumer inputs
eventType

string

Optional event type id to restrict the results to (null for any)
publisherId

string

Optional publisher id to restrict the results to (null for any)
publisherInputFilters

InputFilter[]

Filter for subscription publisher inputs
results

Subscription[]

Results from the query
subscriberId

string

Optional subscriber filter.

SubscriptionStatus

Name Type Description
disabledByInactiveIdentity

string

The subscription is disabled because the owner is inactive or is missing permissions.
disabledBySystem

string

The subscription is disabled by the system.
disabledByUser

string

The subscription is disabled by a user.
enabled

string

The subscription is enabled.
onProbation

string

The subscription is temporarily on probation by the system.