Jira Automation | cside docs

U kunt elke cside-notificatie omzetten in een Jira-werkitem door een webhook-bestemming naar een Jira Automation-regel te laten verwijzen. Dit werkt op elk plan en is de manier om samenvattingen zoals PCI Report Available en Script Blocked by CSP in Jira te krijgen, want de Jira-integratie levert geen samenvattingen af.

Zet het Jira-secret in de URL

Jira Automation verwacht het secret in een X-Automation-Webhook-Token-header. cside-webhooks kunnen geen aangepaste headers versturen, dus voeg het secret in plaats daarvan toe aan het einde van de webhook-URL, zoals Atlassian documenteert voor afzenders zonder aangepaste headers. Zonder het secret weigert Jira elk verzoek met HTTP 400.

Jira Automation of de Jira-integratie?

De Jira-integratie verbindt cside via OAuth met Jira en maakt per waarschuwing één issue aan, met een tabel met details en een link naar het dashboard. Deze is inbegrepen in het Enterprise-plan en verwerkt alleen de directe triggers.

Een Jira Automation-regel die door een webhook wordt gevoed, werkt op elk plan en voor elke trigger, inclusief de samenvattingen. U bepaalt in Jira hoe het werkitem eruitziet.

Wat u nodig heeft

Rechten om automatiseringsregels aan te maken in uw Jira-project
Een cside-notificatieconfiguratie voor de waarschuwingen die u in Jira wilt hebben

Maak de regel aan in Jira

Voeg een incoming webhook-trigger toe

Open in uw Jira-project Project settings > Automation en maak een regel aan. Kies de trigger Incoming webhook en stel Execute this rule with in op No work items from the webhook (op sommige Jira-sites heet deze optie nog No issues from the webhook).

Maak het werkitem aan

Voeg een actie Create work item toe en kies het project en het werktype. Vul de velden in vanuit de cside-payload:

Summary: {{webhookData.summary}}
Description: {{webhookData.description}}

Stel alleen velden in die op het aanmaakscherm van het project staan. Jira negeert de rest en meldt ze in het auditlog.

Schakel de regel in en kopieer de URL en het secret

Sla de regel op en schakel deze in. De trigger toont dan een webhook-URL en een secret. Kopieer beide.

Voeg de webhook-bestemming toe in cside

Stel de URL samen

Voeg een schuine streep en het secret toe aan het einde van de webhook-URL:

https://api-private.atlassian.com/automation/webhooks/jira/a/<id>/<id>/<secret>

Voeg de bestemming toe

Open het dashboard en ga naar Team Settings > Notifications. Bewerk de notificatieconfiguratie, klik onder Send To op Add destination, selecteer Webhook en vul het volgende in:

URL: de URL uit de vorige stap
Secret: een willekeurige waarde. cside gebruikt deze om het verzoek te ondertekenen met een x-cside-signature-header, die Jira niet controleert
Format: JSON

Klik op Save & Test.

Bevestig dat het werkt

Save & Test stuurt een voorbeeldpayload. Bij de meeste triggers begint de summary daarvan met [Test]. Open het Audit log van de regel in Jira: daar zou u een nieuwe run en een aangemaakt werkitem moeten zien.

Jira antwoordt met HTTP 200 wanneer het secret onjuist is, dus een geslaagde test in cside bewijst niet dat de regel is uitgevoerd. Het auditlog is de bevestiging.

Wat u ziet	Wat het betekent
cside-test mislukt met HTTP 400	Het secret ontbreekt in de URL. Jira antwoordt `Missing token`
cside-test mislukt met HTTP 404	De URL is onjuist, of de regel is verwijderd
cside-test slaagt, maar het auditlog toont geen run	Het secret in de URL is onjuist. Kopieer het opnieuw vanuit de trigger
Auditlog: Summary is required	Het veld Summary leverde geen waarde op. Gebruik `{{webhookData.summary}}`
Auditlog: Fields ignored	Een veld in de actie staat niet op het aanmaakscherm, of de automatiseringsgebruiker heeft niet de rechten om het in te stellen. Verwijder het veld uit de actie

Andere velden koppelen

Elke JSON-webhook van cside bevat summary en description zowel op het hoogste niveau als binnen het data-object, omdat Jira Automation een data-sleutel op het hoogste niveau speciaal behandelt. Daarom werkt {{webhookData.summary}} voor elke gebeurtenis. Andere velden verschillen per gebeurtenis; zie de payload-referentie.

Om meer velden te koppelen, voegt u vóór Create work item een Log action toe met {{webhookData}}, stuurt u een test en leest u het auditlog om precies te zien wat Jira heeft ontvangen. Verwijs naar de velden zoals ze daar verschijnen.

Houd het secret veilig

Het secret maakt nu deel uit van de bestemmings-URL, dus iedereen die uw notificatie-instellingen kan bekijken of bewerken, kan het lezen. Als het uitlekt, genereert u een nieuw secret op de Jira-trigger en werkt u de URL in cside bij.

Wat dit nog niet doet

cside kan de X-Automation-Webhook-Token-header, die Atlassian aanbeveelt boven de URL-variant, niet versturen
cside verstuurt een door Jira geweigerde samenvattingswebhook niet opnieuw, en de afleverhistorie wordt niet in het dashboard getoond. Gebruik Save & Test en het Jira-auditlog om de configuratie te bevestigen