Webhook

  • Artikel

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Den här artikeln beskriver webhooks och hur du konfigurerar dem för ditt Azure DevOps-projekt. Webhooks är ett sätt att skicka en JSON-representation av en Azure DevOps-händelse till alla tjänster som har en offentlig slutpunkt.

Kommentar

Azure DevOps debiteras inte för att konfigurera tjänstkrokar eller integrera med externa tjänster. Se den specifika tjänstens webbplats för priser relaterade till deras tjänster.

Förutsättningar

Du behöver följande förutsättningar för att hantera webhooks för en Azure DevOps-organisation:

  • Rollen Ägare eller Projektsamlingsadministratör i organisationen.

  • Ett projekt i organisationen och en tjänst med en offentlig HTTP- eller HTTPS-slutpunkt som du vill skicka Azure DevOps-händelser till.

    Viktigt!

    Vi rekommenderar att du endast använder HTTPS-slutpunkter. HTTP har potential att skicka privata data, inklusive autentiseringshuvuden, okrypterade i händelsenyttolasten. Du måste använda HTTPS för grundläggande autentisering på en webhook.

Skicka JSON-representation till en tjänst

  1. I ditt Azure DevOps-projekt går du till Project settings>Service hooks på .https://<organization-name>/<project-name>/_settings/serviceHooks

    Skärmbild av alternativet Tjänstkrokar i Projektinställningar.

  2. På sidan Service Hooks väljer du + ikonen eller Skapa prenumeration.

    Skärmbild av att välja Skapa prenumeration på sidan Service Hooks.

  3. På skärmen Tjänst väljer du Web Hooks och sedan Nästa.

    Skärmbild av att välja Web Hooks på sidan Tjänst.

  4. På skärmen Utlösare väljer och konfigurerar du den Azure DevOps-händelse som du vill utlösa webhooken på och väljer sedan Nästa. Mer information om JSON-nyttolaster som publicerats av Azure DevOps-konsumenten finns i Händelser med tjänstkrokar.

    Skärmbild av att välja och konfigurera utlösarhändelsen.

  5. På skärmen Åtgärd konfigurerar du mål-URL:en och vad du ska göra när händelsen inträffar. Mer information om vad du anger i Resursinformation att skicka, Meddelanden att skicka och Detaljerade meddelanden att skicka finns i Resursinformation att skicka.

    Kommentar

    Webhooks kan inte rikta in sig på localhost (loopback) eller IPv4/IPv6-adresser för specialintervall.

  6. Välj Testa för att testa prenumerationen på tjänstkroken.

    Skärmbild av hur du konfigurerar dialogrutan Åtgärd.

  7. När testet har slutförts stänger du meddelandeskärmen och väljer sedan Slutför på åtgärdsskärmen .

    Skärmbild av testresultat för prenumerationen på tjänstkroken

  8. Nu har webhooken konfigurerats. Gå till måltjänsten för att visa JSON-representationen.

    Skärmbild av att visa JSON-representationen.

Dricks

Du kan också skapa en webhook programmatiskt. Mer information finns i Skapa en tjänstkrokprenumeration programmatiskt.

Resursinformation som ska skickas

Resursinformationen som ska skickas, Meddelanden att skicka och Detaljerade meddelanden för att skicka inställningar i åtgärdsfönstret styr storleken på JSON-nyttolasten som ska skickas. Resursinformation för att skicka styr hur mycket av resursen som ska skickas. Standardvärdet är Alla, men du kan också välja att skicka Minimal, som endast skickar nyckelfält som URL och ID eller Ingen.

Ingen och Minimal är användbara i scenarier där anroparen inte behöver mycket eller någon information om resursen, eftersom den förlitar sig på själva meddelandet eller det detaljerade meddelandet. Ingen och Minimal är också användbara av säkerhetsskäl. Anroparen måste anropa tillbaka till Azure DevOps Services och gå igenom vanliga säkerhets- och behörighetskontroller för att få mer information om resursen.

Följande JSON-exempel visar minimal information om resursen:

   {
       "eventType": "git.push",
       ...
       "messages": {
           "text": "...",
           "html": "...",
           "markdown": "..."
       },
       "detailedMessage": {
           "text": "...",
           "html": "...",
           "markdown": "..."
       },
       "resource": {
           "id": "...",
           "url": "https://...",
           "name": "...",
           "field1:": "..."
       }
   }

Relaterat innehåll