Webhooky

Článek
04/04/2024

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

Webhooky poskytují způsob, jak odeslat reprezentaci události ve formátu JSON do jakékoli služby. Vyžaduje se pouze veřejný koncový bod (HTTP nebo HTTPS).

Další informace o datových částech JSON odesílaných tímto příjemcem najdete v tématu věnovaném událostem.

Požadavky

Webhooky pro organizaci můžou spravovat jenom vlastníci organizace nebo kolekce projektů Správa istrátory.

Odeslání reprezentace JSON do služby

Přejděte na stránku háky služby projektu:

https://{orgName}/{project_name}/_settings/serviceHooks

Vyberte Vytvořit předplatné.
Vyberte a nakonfigurujte událost Azure DevOps Services:
Nakonfigurujte, co dělat, když dojde k události:

Informace o podrobnostech o prostředcích pro odesílání, odesílání zpráv a podrobné zprávy pro odesílání nastavení najdete v následující části Q &A.
Otestujte předplatné připojení služby a dokončete průvodce:

Teď je webhook nastavený. Přejděte do cílové služby a zobrazte reprezentaci JSON:

Zobrazení reprezentace JSON

Ceny

Azure DevOps neúčtuje poplatky za architekturu pro integraci s externími službami. Podívejte se na web konkrétní služby, kde najdete informace o cenách souvisejících s jejich službami.

Otázky a odpovědi

Otázka: Jaké jsou podrobnosti o zdroji pro odesílání, odesílání zpráv a podrobné zprávy pro odesílání nastavení?

Odpověď: Řídí velikost datové části JSON, která se odešle.

Podrobnosti o zdroji pro odeslání nastavení řídí, kolik prostředku se odešle. Výchozí hodnota je Vše, ale můžete se také rozhodnout odeslat Minimum (odesílá pouze pole s klíči, jako je adresa URL a ID) nebo Žádné.

Žádné a minimální jsou užitečné ve scénářích, kdy volající ve skutečnosti nepotřebuje o prostředku moc, pokud vůbec něco, protože spoléhá na zprávu nebo podrobnou zprávu. Žádné a Minimální jsou také užitečné z bezpečnostních důvodů, například volající musí volat zpět do služby Azure DevOps Services a projít normálními kontrolami zabezpečení a oprávnění, aby získal další podrobnosti o prostředku.

Ukázkový KÓD JSON:

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

Otázka: Můžu programově vytvářet předplatná?

Ano, podrobnosti najdete tady.

Otázka: Můžu odesílat webhooky na jiné koncové body než HTTPS?

Odpověď: Ano. Doporučuje se ale používat pouze koncové body HTTPS pro vaše webhooky. Použití protokolu HTTP znamená, že existuje potenciál odesílání nešifrovaných privátních dat. To zahrnuje všechny hlavičky ověřování ve vašem webhooku.

Otázka: Můžu použít základní ověřování při nastavování webhooku, který není HTTPS?

Odpověď: Ne. Při použití základního ověřování ve webhooku musíte použít protokol HTTPS.

Otázka: Můžeme jako cíle webhooku použít IP adresy místního hostitele nebo speciálního rozsahu?

Odpověď: Ne. Webhooky nemůžou cílit na adresy localhost (loopback) ani speciální rozsah IPv4 /IPv6.

Share via