POST /rest/api/2/webhook
Registers webhooks.
NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook.
Permissions required: Only Connect and OAuth 2.0 apps can use this operation.
Servers
- https://your-domain.atlassian.net
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
url |
String | Yes |
The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app. Only a single URL per app is allowed to be registered. |
webhooks[] |
Array | Yes |
A list of webhooks. |
webhooks[].issuePropertyKeysFilter[] |
Array | No |
A list of issue property keys. A change of those issue properties triggers the |
webhooks[].events[] |
Array | Yes |
The Jira events that trigger the webhook. |
webhooks[].fieldIdsFilter[] |
Array | No |
A list of field IDs. When the issue changelog contains any of the fields, the webhook |
webhooks[].jqlFilter |
String | Yes |
The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.