Azure DevOps Service Hook Creation

Service Hook Creation in ADO

Service Hooks enable Navigator to receive updates due to work item changes in ADO. 

Prerequisite(s)

  • In order to create a Service Hook, the user creating them must have the "Edit subscriptions" and "View subscriptions" permissions set to Allow. (Members of the 'Project Administrators' group have these permissions in the relevant project.)

Steps to Create a Service Hook

  • Ensure the user has the appropriate permissions (see Prerequisites)

  • In ADO, navigate to the desired project

  • Go to Project Settings > Service hooks

  • Add 2 service hooks (repeat these steps a second time, setting the trigger event to "Work item deleted" for the second web hook)

    • Select "Web Hooks" as the type and click "Next"

    • Trigger setup

      • Select "Work item updated" as the event

      • Set Area path to the current project

      • Set "Work item type" to "Any"

      • Set "Tag" to "P2A-Sync" (you may have to create this tag the first time)

      • Set "Field" to "Any"

      • Click "Next"

  • Action setup - this step requires values from Navigator

    • Enter the URL [the webhook url copied from Navigator]

    • Under "HTTP headers" enter the Web Hook client secret values generated by Navigator

      • X-Webhook-Secret:[Web Hook Client Secret from Nav] (the text in the field will look similar to: X-Webhook-Secret:7e974a87dbbfe98341ee43e5468)

    • Leave all other fields set to their default values

    • Click "Test" to test the communication

    • If testing is successful, click "Next" to complete the setup