Integrate with service hooks

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

Service hooks permit you run tasks on other services when events happen in your project in Azure DevOps. For example, create a carte du jour in Trello when a work item is created or transport a push notification to your team's mobile devices when a build fails. You can besides utilize service hooks in custom apps and services equally a more than efficient mode to drive activities when events happen in your projects.

What is a service hook?

Service hook publishers define a fix of events. Subscriptions listen for the events and ascertain actions to take based on the effect. Subscriptions also target consumers, which are external services that can run their own actions, when an consequence occurs.

Service Hooks Diagram

Available services

These services are bachelor as the target of service hooks. To learn about others apps and services that integrate with Azure DevOps Services, visit the Visual Studio Marketplace

Service Supported events Supported actions
App Center Work item updated Send notification
AppVeyor Code pushed Trigger an AppVeyor build
Azuqua All Post effect to FLO
Azure App Service Lawmaking pushed Deploy web app
Azure Service Bus All Ship a message to a Notification Hub, Service Bus Queue, or Service Coach Topic
Azure Storage All Insert a message in a Storage Queue
Bamboo Build completed, Lawmaking pushed Queue a build
Bivouac All Post a message to a room
Datadog All Post an result in Datadog
Flowdock All Post a message to a team inbox or chat
Grafana Release deployment completed Add annotation to Grafana database
HipChat (No longer supported)
HockeyApp Work item updated Ship notification
Jenkins Build completed, code pushed, PR merge attempted, release deployment completed Trigger generic or Git build
Microsoft Teams All Postal service a message to a aqueduct
MyGet Build completed, lawmaking pushed Publish NuGet package to MyGet, trigger a MyGet build
Office 365 All Post a message to a grouping
Slack All Post a message to a aqueduct
Trello All Create a menu or list
UserVoice Work item created or updated Send linked work item effect
Web Hooks All Post via HTTP
Workplace Message Apps All Send notifications
Zapier All Send notification
Zendesk Piece of work item commented on Create a private comment in a ticket

Create a subscription

When yous integrate one of these services with Azure DevOps Services, y'all have to create a new subscription. In many cases, you lot need to do some work in the other service, besides. For specific details, look at the information on the service that you're interested in.

  1. Open the admin folio for a project in web access.

    Screenshot of highlighted Project settings button.
  2. Create a subscription by running the wizard.

    Screenshot of highlighted button, Create subscription.

  3. Select the service you want to integrate with.

    Select the service to integrate

  4. Select the result to trigger on and whatever filters (if applicable).

    Select the event to trigger on and any filters

  5. Select an activeness to run on the target service.

    Note

    The list of bachelor actions may be limited based on the effect type you selected.

    Select an action for the target service

  6. To confirm the settings are correct, test the subscription and then finish the sorcerer.

    Test notification 1 for Azure DevOps Server 2019, 2020, and Azure DevOps Services

    Test notification 2 for Azure DevOps Server 2019, 2020, and Azure DevOps Services

  1. Open the admin folio for a project in web access.

    Screenshot of the admin page.

  2. Create a subscription by running the wizard.

    Screenshot of highlighted box, Create subscription, to select to run the subscription wizard.

  3. Select the service yous want to integrate with.

    Select the service to integrate

  4. Select the event to trigger on and whatsoever filters (if applicable).

    Select the event to trigger on and select any desired filters

  5. Select an action to run on the target service.

    Note

    The list of available deportment may be limited based on the consequence blazon you selected.

    Select an action to perform on the target service

  6. To confirm the settings are correct, test the subscription and and so finish the sorcerer.

    Test notification 1

    Test notification 2

FAQ

Q: What permissions exercise I need to set up a subscription?

A: Edit subscriptions and View subscriptions. By default, just project administrators have these permissions. To grant them to other users directly, y'all tin apply the command line tool or the Security REST API.

Q: What are the security implications of granting Edit subscriptions and View subscriptions permissions?

A: The user with these permissions can see all subscriptions created in the project and the notification history for those subscriptions. That user can and then create any blazon of service hook subscription in that project. If the user sets up a subscription for a resources that they don't otherwise accept permission to access, the subscription won't get triggered.

For example: if y'all don't have access to work items in area path XYZ, and you set a subscription to the work item update events, you lot won't get notifications for updates to work items in area path XYZ. But, if another user, who does take access to the piece of work items in area path XYZ, is receiving those "piece of work particular update" events, then you could see the notification history of the other user's events, which includes work item data that you don't otherwise accept access to.

Q: Can I create service claw subscriptions for a projection programmatically?

A: Yes. For more data, see Create a service hooks subscription.

Q: Tin can I remove an app's access to my organization afterward I've authorized it?

A: Aye. You can revoke authorizations from your profile.

  1. Become to your profile folio from https://visualstudio.com.

    Make sure you start from the Visual Studio site (https://visualstudio.com) instead of your organization (https://dev.azure.com/{orgName}) because, correct at present, your profile accessed from your organisation takes you to the wrong implementation of the authorizations management feature.

  2. Manage your authorizations.

    Click Manage applications to manage authorizations
  3. Revoke any authorizations you lot no longer want to allow.

    Click Revoke to revoke authorizations

Q: Why can't we gear up Service Hooks for HipChat anymore?

A: Atlassian officially dropped support for HipChat. Run across more than on that announcement here.

  • Troubleshoot service hooks and FAQs
  • Visual Studio Marketplace
  • Billing information