Deprecating workflowId in webhooks sent from the Trigger a Webhook Workflow Post Function
- Announced
- Effective
- Sunset
- APIs
- connect-core-platform
- Severity
- breaking, set by
reef/atlassian-rule-v1 - Source
- https://developer.atlassian.com/changelog/#CHANGE-3339
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: [object Object]
The text above is Atlassian's. reef added the severity, the dates it could read from the text, and the endpoints and scopes named in code.