Delen via

Gebruikers van service hooks

  • Artikel

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Gebruik servicehookgebruikers om programmatisch een abonnement te maken. Het abonnement geeft de gebeurtenis, de consument en de actie op.

Selecteer de consument die u wilt gebruiken in uw abonnement van de volgende consumenten. Zie Integreren met servicehook, Beschikbare services voor meer informatie over beschikbare services.

Azure Service Bus

Biedt integratie met Microsoft Azure Service Bus, waaronder Notification Hubs.

Een bericht verzenden naar een Notification Hub

Met deze actie wordt een algemene sjabloonmelding verzonden naar de opgegeven Azure Notification Hub. Zie het overzicht voor meer informatie.

  • Consumenten-id: azureServiceBus
  • Actie-id: serviceBusNotificationHubSend
  • Ondersteunde gebeurtenissen: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Instellingen:
    • connectionString
      • SAS-verbindingsreeks
      • De SAS (Shared Access Signature) verbindingsreeks om verbinding te maken met Azure Service Bus. Deze verbindingsreeks is beschikbaar in Azure Portal.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • notificationHubName
      • Naam van meldingshub
      • De naam van de Notification Hub waar de melding naartoe moet worden verzonden. De naam mag alleen letters, cijfers, punten, afbreekstreepjes, slashes en onderstrepingstekens bevatten. De naam moet beginnen en eindigen met een letter of cijfer. De hub moet al bestaan.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • tagsExpression
      • Tags
      • De tagsexpressie (voor het instellen van specifieke sets apparaten). Meer informatie.
      • Gegevenstype: tekenreeks
      • Vereist: Nee

Een bericht verzenden naar een Service Bus-wachtrij

Met deze actie wordt een JSON-tekenreeksweergave van de gebeurtenis verzonden naar de opgegeven Azure Service Bus-wachtrij. Zie Service Bus-wachtrijen, -artikelen en -abonnementen voor meer informatie.

  • Consumenten-id: azureServiceBus
  • Actie-id: serviceBusQueueSend
  • Ondersteunde gebeurtenissen: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Instellingen:
    • connectionString
      • SAS-verbindingsreeks
      • De SAS (Shared Access Signature) verbindingsreeks om verbinding te maken met Azure Service Bus. Deze verbindingsreeks is beschikbaar in Azure Portal.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • queueName
      • Wachtrijnaam
      • De naam van de wachtrij waar het bericht naartoe moet worden verzonden. De naam mag alleen letters, cijfers, punten, afbreekstreepjes, slashes en onderstrepingstekens bevatten. De naam moet beginnen en eindigen met een letter of cijfer. Als de wachtrij niet bestaat, wordt deze gemaakt als de opgegeven verbindingsreeks over de benodigde machtigingen beschikt.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • resourceDetailsToSend
      • Resourcegegevens die moeten worden verzonden
      • De resourcevelden beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • messagesToSend
      • Berichten die moeten worden verzonden
      • De berichten beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • detailedMessagesToSend
      • Gedetailleerde berichten die moeten worden verzonden
      • De gedetailleerde berichten beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee

Een bericht verzenden naar een Service Bus-onderwerp

Met deze actie wordt een JSON-tekenreeksweergave van de gebeurtenis verzonden naar het opgegeven Azure Service Bus-onderwerp. Zie De Azure-portal gebruiken om een Service Bus-onderwerp en abonnementen voor het onderwerp te maken voor meer informatie.

  • Consumenten-id: azureServiceBus
  • Actie-id: serviceBusTopicSend
  • Ondersteunde gebeurtenissen: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Instellingen:
    • connectionString
      • SAS-verbindingsreeks
      • De SAS (Shared Access Signature) verbindingsreeks om verbinding te maken met Azure Service Bus. Deze verbindingsreeks is beschikbaar in Azure Portal.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • topicName
      • Onderwerpnaam
      • De naam van het onderwerp waar het bericht naartoe moet worden verzonden. De naam mag alleen letters, cijfers, punten, afbreekstreepjes, slashes en onderstrepingstekens bevatten. De naam moet beginnen en eindigen met een letter of cijfer. Als het onderwerp niet bestaat, wordt het gemaakt als de opgegeven verbindingsreeks over de benodigde machtigingen beschikt.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • resourceDetailsToSend
      • Resourcegegevens die moeten worden verzonden
      • De resourcevelden beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • messagesToSend
      • Berichten die moeten worden verzonden
      • De berichten beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • detailedMessagesToSend
      • Gedetailleerde berichten die moeten worden verzonden
      • De gedetailleerde berichten beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee

Azure Storage

Biedt integratie met Microsoft Azure Storage.

Een bericht invoegen in een opslagwachtrij

Met deze actie wordt een JSON-tekenreeksweergave van de gebeurtenis ingevoegd in de opgegeven Azure Storage-wachtrij. Zie Wat zijn Azure-wachtrijen? voor meer informatie.

  • Consumenten-id: azureStorageQueue
  • Actie-id: inquentue
  • Ondersteunde gebeurtenissen: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Instellingen:
    • accountName
      • Naam van het opslagaccount
      • De naam die is gekoppeld aan uw Azure-opslagaccount (bijvoorbeeld https://STORAGE_ACCOUNT_NAME.queue.core.windows.net).
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • accountKey
      • Opslagaccountsleutel
      • De sleutel die is gekoppeld aan uw Azure-opslagaccount.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • queueName
      • Wachtrijnaam
      • De naam alleen in kleine letters van de wachtrij die moet worden gebruikt in Azure Storage. Er wordt een wachtrij met deze naam gemaakt als deze nog niet bestaat.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • visiTimeout
      • Time-out voor zichtbaarheid van berichten (in seconden)
      • Hiermee geeft u de time-outwaarde voor zichtbaarheid, in seconden, voor het verzonden bericht ten opzichte van de servertijd. De waarde moet groter zijn dan of gelijk zijn aan 0 en mag niet groter zijn dan zeven dagen of 604.800 seconden. De time-out voor zichtbaarheid moet worden ingesteld op een waarde die kleiner is dan de time-to-live-waarde van het bericht.
      • Gegevenstype: getal
      • Vereist: Ja
    • Ttl
      • Time-to-live van bericht (in seconden)
      • Hiermee geeft u het time-to-live-interval voor het wachtrijbericht, in seconden. De maximaal toegestane time-to-live is zeven dagen of 604.800 seconden.
      • Gegevenstype: getal
      • Vereist: Ja
    • resourceDetailsToSend
      • Resourcegegevens die moeten worden verzonden
      • De resourcevelden beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • messagesToSend
      • Berichten die moeten worden verzonden
      • De berichten beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • detailedMessagesToSend
      • Gedetailleerde berichten die moeten worden verzonden
      • De gedetailleerde berichten beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee

Jenkins

Jenkins is een continue integratieserver, waarmee softwareprojecten continu kunnen worden gebouwd en getest.

Git-build activeren

Hiermee wordt een build geactiveerd die is geconfigureerd voor het gebruik van een Git-opslagplaats met behulp van de Jenkins Git-invoegtoepassing.

  • Consumenten-id: jenkins
  • Actie-id: triggerGitBuild
  • Ondersteunde gebeurtenissen: git.push
  • Instellingen:
    • serverBaseUrl
      • Jenkins-basis-URL
      • De basis-URL die als host fungeert voor de Jenkins-server
      • Gegevenstype: URI
      • Vereist: Ja
    • gebruikersnaam
      • User name
      • De Jenkins-gebruikersnaam van een gebruiker die de build mag activeren
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • password
      • Gebruikers-API-token (of wachtwoord)
      • Het API-token van de gebruiker, dat beschikbaar is op de configuratiepagina van de Jenkins-gebruiker. Het API-token is nieuw sinds versie 1.426. Voor eerdere versies van Jenkins moet het echte gebruikerswachtwoord worden opgegeven.
      • Gegevenstype: tekenreeks
      • Vereist: Ja

Algemene build activeren

Hiermee wordt een algemene Jenkins-build geactiveerd die de Jenkins-build-URL aanroept.

  • Consumenten-id: jenkins
  • Actie-id: triggerGenericBuild
  • Ondersteunde gebeurtenissen: git.push, build.complete, tfvc.checkin
  • Instellingen:
    • serverBaseUrl
      • Jenkins-basis-URL
      • De basis-URL die als host fungeert voor de Jenkins-server
      • Gegevenstype: URI
      • Vereist: Ja
    • gebruikersnaam
      • User name
      • De Jenkins-gebruikersnaam van een gebruiker die de build mag activeren
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • password
      • Gebruikers-API-token (of wachtwoord)
      • Het API-token van de gebruiker, dat beschikbaar is op de configuratiepagina van de Jenkins-gebruiker. Het API-token is nieuw sinds versie 1.426. Voor eerdere versies van Jenkins moet het echte gebruikerswachtwoord worden opgegeven.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • buildName
      • Build
      • De buildnaam die moet worden geactiveerd
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • buildAuthToken
      • Buildtoken
      • Het autorisatietoken in de vorm van een tekenreeks, zodat alleen gebruikers die weten dat het op afstand de builds van dit project kunnen activeren
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • buildParameterized
      • Accepteert parameters
      • Geeft aan of de build al dan niet is geparameteriseerd (buildparameters zijn optioneel eerder opgegeven)
      • Gegevenstype: Booleaanse waarde
      • Vereist: Nee
    • buildParams
      • Buildparameters
      • Bouw parametersnamen en -waarden, gescheiden door een dubbele punt (bijvoorbeeld 'param1:value1') waarbij elke naam-waardepaar wordt weergegeven op een eigen regel tekst
      • Gegevenstype: tekenreeks
      • Vereist: Nee

Trello

Biedt integratie met Trello.

Maak een kaart

Met deze actie maakt u een kaart op een bestaande lijst in Trello. Een kaart kan een taak, probleem, gebeurtenis of iets anders voorstellen. De status van een kaart wordt doorgaans bepaald door de lijst waarin deze staat. Zie Een servicehook maken met Trello voor meer informatie.

  • Consumenten-id: trello
  • Actie-id: createCard
  • Ondersteunde gebeurtenissen: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Instellingen:
    • userToken
      • Gebruikerstoken (hebt u er een nodig? Nu downloaden.)
      • Uw gebruikerstoken dat is verstrekt door Trello. Als u wilt weten hoe u dit token kunt verkrijgen, selecteert u de koppeling in de eerder beschreven actiebeschrijving.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • boardId
      • Bord
      • De naam van het bord waarop de Trello-kaart wordt gemaakt.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • listId
      • List
      • De naam van de lijst waarop de Trello-kaart wordt gemaakt.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • labels
      • Etiketten
      • Een door komma's gescheiden lijst met labelkleuren die moeten worden toegepast op de gemaakte kaart. Geldige labelkleurnamen zijn rood, oranje, geel, groen, blauw en paars.
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • addToTop
      • Maken aan het begin van de lijst
      • Geeft aan of de kaart moet worden gemaakt aan het begin van de Trello-lijst, in plaats van het einde.
      • Gegevenstype: Booleaanse waarde
      • Vereist: Nee

Een lijst maken

Met deze actie maakt u een lijst op een bestaand bord in Trello. Een lijst wordt gebruikt om kaarten op een bord te ordenen en vertegenwoordigt meestal een status. Zie Een servicehook maken met Trello voor meer informatie.

  • Consumenten-id: trello
  • Actie-id: createList
  • Ondersteunde gebeurtenissen: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Instellingen:
    • userToken
      • Gebruikerstoken (hebt u er een nodig? Nu downloaden.)
      • Uw gebruikerstoken dat is verstrekt door Trello. Als u wilt weten hoe u dit token kunt verkrijgen, selecteert u de koppeling in de eerder beschreven actiebeschrijving.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • boardId
      • Bord
      • De naam van het bord waarop de Trello-lijst wordt gemaakt.
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • addToBottom
      • Onder aan bord maken
      • Geeft aan of de lijst onder aan het bord moet worden gemaakt in plaats van bovenaan.
      • Gegevenstype: Booleaanse waarde
      • Vereist: Nee

Webhooks

Webhooks bieden gebeurteniscommunicatie via HTTP.

Posten via HTTP

Met deze actie wordt een JSON-objectweergave van de gebeurtenis op de opgegeven URL geplaatst. HTTPS-eindpunten worden aanbevolen vanwege het potentieel voor privégegevens in de nettolading van de gebeurtenis. Zie Webhooks voor meer informatie.

  • Consumenten-id: webHooks
  • Actie-id: httpRequest
  • Ondersteunde gebeurtenissen: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Instellingen:
    • URL
      • URL
      • De URL waarnaar een HTTP POST wordt verzonden.
      • Gegevenstype: URI
      • Vereist: Ja
    • httpHeaders
      • HTTP-kopteksten
      • HTTP-headersleutels en -waarden gescheiden door een dubbele punt (bijvoorbeeld 'Key1:value1') waarbij elk sleutel-waardepaar wordt weergegeven op een eigen regel tekst.
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • basicAuthUsername
      • Gebruikersnaam voor basisverificatie
      • Voer een gebruikersnaam in voor standaard HTTP-verificatie. Met basis-HTTP-verificatie worden referenties in tekst zonder opmaak verzonden (niet-versleuteld). Dit betekent dat u een URL moet gebruiken die begint met https om versleuteling van deze referenties in te schakelen via SSL (Secure Transport Layer).
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • basicAuthPassword
      • Basisverificatiewachtwoord
      • Voer een wachtwoord in voor standaard HTTP-verificatie. Basis-HTTP-verificatie verzendt referenties in tekst zonder opmaak (niet-versleuteld), wat betekent dat u een URL moet gebruiken die begint met https om versleuteling van deze referenties via SSL in te schakelen.
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • resourceDetailsToSend
      • Resourcegegevens die moeten worden verzonden
      • De resourcevelden beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • messagesToSend
      • Berichten die moeten worden verzonden
      • De berichten beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee
    • detailedMessagesToSend
      • Gedetailleerde berichten die moeten worden verzonden
      • De gedetailleerde berichten beheren die moeten worden verzonden
      • Gegevenstype: tekenreeks
      • Vereist: Nee

Zendesk

Zendesk is een SaaS-suite die helpdesktickets, problemen bijhouden en klantenserviceondersteuning biedt.

Een persoonlijke opmerking maken in een ticket

Gebruik Zendesk om een persoonlijke opmerking in een ticket te maken.

  • Consumenten-id: zendesk
  • Actie-id: createPrivateComment
  • Ondersteunde gebeurtenissen: workitem.commented
  • Instellingen:
    • accountName
      • Accountnaam
      • Zendesk-accountnaam zoals https://{account name}.zendesk.com
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • gebruikersnaam
      • User name
      • De Zendesk-gebruikersnaam van een gebruiker die tickets bijwerken
      • Gegevenstype: tekenreeks
      • Vereist: Ja
    • apiToken
      • API-token
      • Het Zendesk API-token (te vinden in zendesk-app in de API voor beheerkanalen > > )
      • Gegevenstype: tekenreeks
      • Vereist: Ja