I'm using Jira Software in Docker (tag latest
), and the backend reports this version:
"version": "10.5.1"
I'm trying to create a webhook via this endpoint:
POST /rest/jira-webhook/1.0/webhooks
Following the documentation here:
https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-using-the-rest-api--for-connect-and-oauth-2-0-apps-
I'm including a secret
field in the payload:
{
"name": "My Webhook",
"url": "https://example.com/webhook",
"events": ["jira:issue_created"],
"secret": "my-secret-value"
}
The webhook is created successfully, but the secret
is not saved — it only works when creating the webhook manually via the UI. This behavior works correctly in Jira Cloud, but not in the self-hosted version.
Is there anything I might be missing?
Should I consider using a different Jira version or API version to enable support for webhook secrets via the REST API?
If so, which specific version would support this functionality?
Welcome to the community.
See the documentation here: https://developer.atlassian.com/server/jira/platform/webhooks/#operations-with-a-webhook-via-the-jira-rest-api
This is related to the server platform.
Thanks for the reference!
I followed the API Hook format outlined in the Jira Server documentation for versions 10 and above. While the webhook is created successfully, the secret
field doesn't seem to be set correctly. Here’s the payload I used:
{
"name": "hookNameExample",
"url": "https://example/hook",
"events": ["jira:issue_updated"],
"secret": "-somesecret"
}
The server documentation doesn’t clearly mention how to set a secret, so I used the secret
field name as defined in the Cloud API. However, it appears that this works only on Jira Cloud, not on Server.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
Correct, Cloud API functions don't work in server.
You could contact Atlassian Support and see if this is even possible with a secret option.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
I resolved the issue by updating the configuration field in the payload as follows:
configuration: {
SECRET: 'some-secret',
}
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
Online forums and learning are now in one easy-to-use experience.
By continuing, you accept the updated Community Terms of Use and acknowledge the Privacy Policy. Your public name, photo, and achievements may be publicly visible and available in search engines.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.