Tagger, Date, and Message fields missing in Webhook Payloads and the Rest API
Platform Notice: Cloud Only - This article only applies to Atlassian products on the cloud platform.
Summary
When setting up a Webhook inside your Bitbucket Cloud repository with a trigger for repo:push or fetching Tags from the Rest API, the tag data is expected to be displayed inside the Webhook payload or the Rest API response. However, in some cases, the information contained within tags, such as the Tagger, Date, and Message fields, can be displayed as null.
1
2
3
4
5
6
"new": {
"tagger": null,
"date": null,
"message": null,
"type": "tag"
}Solution
According to Git's official tags documentation, Git supports two types of tags: Annotated Tags and Lightweight Tags.
Annotated Tags
Annotated tags are full objects stored within Git's database and contain all information related to these specific tags, such as a checksum, the tagger, the date, and a tagging message in case it was provided. Annotated tags can be created with the following syntax:
1
$ git tag -a v1.0 -m "My Annotated Tag"Lightweight Tags
Lightweight tags, on the other hand, are simply pointers that reference a commit in Git's history, so it does not contain any of the expected data for Webhook payloads stored within it. Lightweight tags are created with the following syntax:
1
$ git tag v1.0In cases where the Tagger, Date, and Message fields are missing from the Webhooks payload, users must ensure that they are not using Lightweight tags locally and switch to Annotated tags if necessary. Once an Annotated tag is created and pushed to Bitbucket, the Webhook payload and the Rest API response will contain the expected data inside their respective fields:
1
2
3
4
5
6
"new": {
"tagger": {},
"date": 2022-01-01T22:30:00+00:00,
"message": "My Annotated Tag",
"type": "tag"
}Was this helpful?