Deprecating workflowId in webhooks sent from the Trigger a Webhook Workflow Post Function

We are deprecating the workflowId field in the webhook payloads sent via the Trigger a webhook post function in Jira workflows. This field now returns a placeholder value, and will be removed after 31 July 2027.

The workflowId is an invalid value and may lead to bugs in your webhook handlers if used. It references an internal identifier that does not correspond to a workflow and cannot be mapped to any workflow in our public APIs.

If you are using workflowId, you should instead use workflowName or workflowEntityId, which contains a value that can be used to correctly identify workflows.

More details

What's changing

The workflowId field in webhook payloads sent via the Trigger a webhook post function now returns a placeholder value. The field will remain in the payload until it is removed after 31 July 2027, but its value should not be relied upon.

Why

The workflowId value references an internal identifier that does not correspond to a workflow. It cannot be used to query or identify workflows through our public APIs, and using it can cause unexpected behaviour or bugs in your webhook handlers.

What you need to do Before 31 July 2027:

• Identify any integrations that read workflowId from these webhook payloads. • Replace usages of workflowId with workflowEntityId.

See the example shape of a webhook below (or read the relevant documentation here: https://developer.atlassian.com/cloud/jira/platform/webhooks/#webhook-payload )

{
    "timestamp": 1606480436302,
    "webhookEvent": "jira:issue_updated",
    "issue_event_type_name": "issue_generic"
    "user": {
        ...
    },
    "issue": {
        --> See Issue shape in table below
    },
    "transition" : {
        "from_status": "Open",
        "to_status": "Resolved",
        "transitionId": 5,
        "transitionName": "Resolve Issue",
        "workflowName": "example workflow"
        "workflowId": 99999, --> this is now a placeholder value
        "workflowEntityId": "<some UUID>" <-- newly added, should be used.
    }