Register dynamic webhooks

POST

/rest/api/3/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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/webhook' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://your-app.example.com/webhook-received",
    "webhooks": [
        {
            "events": [
                "jira:issue_created",
                "jira:issue_updated"
            ],
            "fieldIdsFilter": [
                "summary",
                "customfield_10029"
            ],
            "jqlFilter": "project = PROJ"
        },
        {
            "events": [
                "jira:issue_deleted"
            ],
            "jqlFilter": "project IN (PROJ, EXP) AND status = done"
        },
        {
            "events": [
                "issue_property_set"
            ],
            "issuePropertyKeysFilter": [
                "my-issue-property-key"
            ],
            "jqlFilter": "project = PROJ"
        }
    ]
}'

Response Example

200 - Success

{"webhookRegistrationResult":[{"createdWebhookId":1000},{"errors":["The clause watchCount is unsupported"]},{"createdWebhookId":1001}]}

Request

Body Params application/json

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

🟠400Returned if the request is invalid.

🟠403Returned if the caller isn't an app.

Modified at 2023-07-13 03:27:27

Get dynamic webhooks for app

Delete webhooks by ID