nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Using Web hook and configuration

serge calderara

Dear all,

We have a jira DC which need to send project issue information on create and update trigger.

We have actually 2 option for doing this :

Automation rule
Web hook

The question we have actually is that we would rather prefer web hook as it is handling sending by itself behind the scene.

Q1 : Does the web hook end point can use only token as part of the URL or is it posible to have basic auth ?

Q2 : When an CREATE / UPDATE even is trigger in web Hook, does the all issue fields are send as the body or can the body be customized ?

Q3 : When UPDATE trigger is use and Comment field is set for update, does only the comment field is send as body to the endpoint or does it send all time the full issue fields ?

Thanks for this clarification

regards

Accepted answers

Nicketa

Hello @serge calderara ,

You can use Automation for Jira as well. End points can be customized.

Screenshot 2024-10-04 135558.png

For update also, you have to decide on which field value update you want to send update.

Screenshot 2024-10-04 140323.png

BR,

Nicketa

All comments

Evgenii

Hi, @serge calderara

I already passed that way. And I think, that Jira Automation is better. About your questions:

A1: Only tokens, you can't use password there

A2: Body can't be customized and it's very bad. It sends event type and new data

A3: Only changes and basic fields, not all.

You can test it by yourself. Just google "webhook online testing tool". There are many such services. They'll give you url, which you add in Jira, and send there events.

For example, I used such service, and received next answer for comment event:

Why it's better to use automation for me - it's more flexible in configuration. You can change request body.

serge calderara

@Evgenii thnaks for your feedback.

I agreed from automation that it is better to use it in case you need to have full control on what is send.

But if you need to send all time the full issue fields and let the other side application pick up what it needs, then I guess WebHook are better in that send as you do not have to pay attention on the body send.

Agreed ?

regards

Evgenii

@serge calderara from that point you're right. As always, everything depends from initial requirements If you don't need custom body, then it's better to use webhook, else - automation.

serge calderara

@Evgenii we are then align with same opinion.

I have read somwhere that the bootlnect of webhook is if the body is quite heavy or if there are more than one trigger occuring, send might be queue with a max queue size of 20 and if queue is full successive webhook will be ignored.

Have you heard something on this or perfomance issue on using webhook ?

An other question is that in case of Attacment are in the body, how the client app will get the attachement file ?

regards

Nicketa

Hello @serge calderara ,

You can use Automation for Jira as well. End points can be customized.

Screenshot 2024-10-04 135558.png

For update also, you have to decide on which field value update you want to send update.

Screenshot 2024-10-04 140323.png

BR,

Nicketa

Q1 : Does the web hook end point can use only token as part of the URL or is it possible to have basic auth ?

Authorizations can be used like below:

Screenshot 2024-10-04 140829.png

Q2 : When an CREATE / UPDATE even is trigger in web Hook, does the all issue fields are send as the body or can the body be customized ?

ANS: You can keep it as custom data.

Q3 : When UPDATE trigger is use and Comment field is set for update, does only the comment field is send as body to the endpoint or does it send all time the full issue fields ?

ANS: If you have customizations, you can choose it.

serge calderara

@Nicketa thanks for your reply.

IN my automation, I have a issue update trigger.

Then what I notice is that if I change any default issue field like priority, description,... then the payload catch the change and we can see update field in post request.

But if we add a comment to the issue or even an attchment, then nothing is track in the payload.

Any idea why attachment and comment update does not get send ?

regards

Nicketa

@serge calderara

You might need to review the payload for comments and attachments.

For Attachments, can refer to: https://confluence.atlassian.com/jirakb/how-to-add-an-attachment-to-a-jira-issue-using-rest-api-699957734.html

For comments, https://developer.atlassian.com/server/jira/platform/jira-rest-api-example-add-comment-8946422/

Can try below format:

{
 "update": {
  "comment": [
   {
    "add": {
      "body": "{comment}"
      }
     }
    ]
   }
}

BR,

Nicketa

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

server

jira

jira-server

jira-data-center

data-center