How to Pass a Custom Header in a Webhook Request?
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
The purpose of this article is to provide a way to send a Webhook Request from the Jira application using custom headers.
Environment
Jira Server/Data Center 8.0.0 and above, along with Automation for Jira 7.4.0 and above.
Solution
There are 2 ways to configure webhooks in Jira.
The 1st way is to use Jira native webhook feature, which does not allow to use custom headers
The 2nd way is to configure webhooks using Jira automation rules, which allow to use custom headers
To add custom headers to the webhook, you will need to configure a new automation rule, using the trigger of your choice, and the Send Web Request action
Custom headers can be added via the Headers (optional) field.
In the example below, "apikey" is the header name and "1234" is the value:
Was this helpful?