Webhook Custom Template Variables
Data Model Variables
Please refer to Webhook Custom Template Overview for the description of the function.
1. Event Information
| Name | Type | Description | Example |
|---|---|---|---|
| tenant.id | Long | Tenant ID | 1 |
| trigger.date | Date | Trigger Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| trigger.user.id | Long | Trigger User ID | 2 |
| trigger.user.name | String | Trigger User Name | Bob |
| trigger.user.email | String | Trigger User Email | bob.test@leiga.com |
| trigger.user.phone | String | Trigger User Phone Number | 12345678901 |
| event.type.id | String | Event Type ID | Issue.Create |
| event.type.subject.code | String | Event Type - Event Type Code Comment: Comment | Issue |
| event.type.subject.name | String | Event Type - Event Type Name | Event |
| event.type.action.code | String | Event Type - Operation Type Code Create: Create Update: Update Delete: Delete Action: Automation Action Test: Test | Create |
| event.type.action.name | String | Event Type - Operation Type Name | Action |
2. Issue Information
2.1 Issue Basic Information
| Name | Type | Description | Example |
|---|---|---|---|
| issue.id | Long | Primary Key | 100 |
| issue.summary | String | Summary | Summary of the work |
| issue.url | String | Link | Applicable Functions: None Type: String Description: Link Example: https://app.leiga.com/work/table Applicable Services: Leiga |
| issue.createTime | Date | Create Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.updateTime | Date | Update Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.description | String | Description | Description of the work |
| issue.epic.id | Long | Epic Primary Key | 30289115 |
| issue.epic.summary | String | Epic Summary | Click for Epic details |
| issue.startDate | Date | Start Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.dueDate | Date | Due Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.number | Long | ID | 8 |
| issue.type.id | Long | idWork Type ID | 1100 |
| issue.type.name | String | Work Type Name | Bug |
| issue.type.code | String | Work Type Code | bug |
| issue.priority.id | Long | Priority ID | 1200 |
| issue.priority.name | String | Priority Name | High |
| issue.priority.optionKey | String | Priority Code | High |
| issue.status.id | Long | Workflow Status ID | 4 |
| issue.status.name | String | Workflow Status Name | Done |
| issue.status.category.id | Long | Workflow Status Type ID | 4 |
| issue.status.category.name | String | Workflow Status Type Name | Completed |
| issue.status.code | String | Workflow Status Code | Done |
| issue.assignee.id | Long | Assignee ID | 101 |
| issue.assignee.name | String | Assignee Name | Bob |
| issue.assignee.email | String | Assignee Email | bob.test@leiga.com |
| issue.assignee.phone | String | Assignee Phone Number | 12345678901 |
| issue.owner.id | Long | Owner ID | 101 |
| issue.owner.name | String | Owner Name | Bob |
| issue.owner.email | String | Owner Email | bob.test@leiga.com |
| issue.owner.phone | String | Owner Phone Number | 12345678901 |
| issue.createBy.id | Long | Create By ID | 101 |
| issue.createBy.name | String | Create By Name | Bob |
| issue.createBy.email | String | Create By Email | bob.test@leiga.com |
| issue.createBy.phone | String | Create By Phone Number | 12345678901 |
| issue.updateBy.id | Long | Update By ID | 101 |
| issue.updateBy.name | String | Update By Name | Bob |
| issue.updateBy.email | String | Update By Email | bob.test@leiga.com |
| issue.updateBy.phone | String | Update By Phone Number | 12345678901 |
| issue.follows[0].id | Long | Followers ID | 101 |
| issue.follows[0].name | String | Followers Name | Bob |
| issue.follows[0].email | String | Followers Email | bob.test@leiga.com |
| issue.follows[0].phone | String | Followers Phone Number | 12345678901 |
2.2 Issue Time Tracking and Estimated Points
| Name | Type | Description | Example |
|---|---|---|---|
| issue.labour.estimate | BigDecimal | Estimated Time (Seconds) | 7200 |
| issue.labour.actual | BigDecimal | Time Spent (Seconds) | 3600 |
| issue.labour.remaining | BigDecimal | Remaining (Seconds) | 3600 |
| issue.labour.totalActual | BigDecimal | Total Time Spent (Including Subtasks) (Seconds) | 3600 |
| issue.labour.totalRemaining | BigDecimal | Total Remaining (Including Subtasks) (Seconds) | 3600 |
| issue.labour.totalEstimate | BigDecimal | Total Estimated Time (Including Subtasks) (Seconds) | 7200 |
| issue.estimatePoint.value | BigDecimal | Estimated Points | 3 |
| issue.estimatePoint.autoCalculateFlag | Integer | Flag for automatic summing of subtask points When the “Sum of Subtask estimation” option is selected In “Estimated Points”, the value of "Flag for automatic summing of subtask points" is 1; otherwise, it is 0. | 0 |
2.3 Issue Affiliated Project Information
| Name | Type | Description | Example |
|---|---|---|---|
| issue.project.id | Long | id | 900 |
| issue.project.name | String | Name | Sample Project |
| issue.project.description | String | Description | Description of the Project |
| issue.project.startTime | Date | Start Date | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.project.endTime | Date | End Date | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.project.updateTime | Date | Update Date | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.project.archived | Integer | Archived or not | 0 |
| issue.project.leader.id | Long | Owner ID | 101 |
| issue.project.leader.name | String | Owner Name | Bob |
| issue.project.leader.email | String | Owner Email | bob.test@leiga.com |
| issue.project.leader.phone | String | Owner Phone Number | 12345678901 |
| issue.project.createBy.id | Long | Create By ID | 101 |
| issue.project.createBy.name | String | Create By Name | Bob |
| issue.project.createBy.phone | String | Create By Phone Number | 12345678901 |
| issue.project.createBy.email | String | Create By Email | bob.test@leiga.com |
| issue.project.createTime | Date | Create Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
2.4 Issue Affiliated Sprint Information
| Name | Type | Description | Example |
|---|---|---|---|
| issue.sprint.id | Long | Sprint ID | 1400 |
| issue.sprint.name | String | Sprint Name | Sprint Name |
| issue.project.startDate | Date | Sprint Start Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.project.endDate | Date | Sprint End Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.project.completeDate | Date | Sprint Finish Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.sprint.started | Integer | Has the sprint started | 1 |
| issue.sprint.closed | Integer | Has the sprint been closed | 0 |
| issue.sprint.goal | String | Sprint Goal | V 1.0 Features Collection |
| issue.sprint.status.id | Long | Sprint Status ID | 4 |
| issue.sprint.status.name | String | Sprint Status Name | Done |
| issue.sprint.status.category.id | Long | Sprint Status Type ID | 4 |
| issue.sprint.status.category.name | String | Sprint Status Type Name | Done |
| issue.sprint.status.code | String | Sprint Status Code | Done |
| issue.sprint.assignee.id | Long | Sprint Assignee ID | 101 |
| issue.sprint.assignee.name | String | Sprint Assignee Name | Bob |
| issue.sprint.assignee.email | String | Sprint Assignee Email | bob.test@leiga.com |
| issue.sprint.assignee.phone | String | Sprint Assignee Phone Number | 12345678901 |
| issue.sprint.project.id | Long | Project ID With Sprint Feature | 900 |
| issue.sprint.project.name | String | Project Name With Sprint Feature | Sample Project |
| issue.sprint.project.description | String | Project Description With Sprint Feature | Description of the Project |
| issue.sprint.project.startTime | Date | Project Start Date With Sprint Feature | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.sprint.project.endTime | Date | Project End Date With Sprint Feature | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.sprint.project.createTime | Date | Project Create Time With Sprint Feature | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.sprint.project.updateTime | Date | Project Update Time With Sprint Feature | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.sprint.project.archived | Integer | Has The Project With Sprint Feature Archived | 0 |
| issue.sprint.project.createBy.id | Long | Project Creator ID With Sprint Feature | 101 |
| issue.sprint.project.createBy.email | String | Project Creator's Email With Sprint Feature | bob.test@leiga.com |
| issue.sprint.project.createBy.name | String | Project Creator's Name With Sprint Feature | Bob |
| issue.sprint.project.createBy.phone | String | Project Creator's Phone Number With Sprint Feature | 12345678901 |
| issue.sprint.project.leader.id | Long | Project Owner ID With Sprint Feature | 101 |
| issue.sprint.project.leader.email | String | Project Owner's Email With Sprint Feature | bob.test@leiga.com |
| issue.sprint.project.leader.name | String | Project Owner‘s Name With Sprint Feature | Bob |
| issue.sprint.project.leader.phone | String | Project Owner‘s Phone Number With Sprint Feature | 12345678901 |
2.5 Issue Linked Releases
| Name | Type | Description | Example |
|---|---|---|---|
| issue.releaseVersion.id | Long | Release ID | 1500 |
| issue.releaseVersion.name | String | Release Name | Release Name |
| issue.releaseVersion.status.id | Long | Release Status ID | 4 |
| issue.releaseVersion.status.name | String | Released Status Name | Released |
| issue.releaseVersion.status.category.id | Long | Release Status Type ID | 4 |
| issue.releaseVersion.status.category.name | String | Release Status Type Name | Done |
| issue.releaseVersion.status.code | String | Release Status Code | Done |
| issue.releaseVersion.released | Integer | Has the Release been Released | 0 |
| issue.releaseVersion.archived | Integer | Has the Release been Archived | 0 |
| issue.releaseVersion.url | String | Release Link | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.releaseVersion.startDate | Date | Release Start Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.releaseVersion.releasedDate | Date | Release Time of the Release | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| issue.releaseVersion.description | String | Release Description | Release Description |
| issue.releaseVersion.owner.id | Long | Release Owner ID | 101 |
| issue.releaseVersion.owner.name | String | Release Owner Name | Bob |
| issue.releaseVersion.owner.email | String | Release Owner's Email | bob.test@leiga.com |
| issue.releaseVersion.owner.phone | String | Release Owner’s Phone Number | 12345678901 |
2.6 Issue Customized Field Information
| Name | Type | Description | Example |
|---|---|---|---|
| customFields[0].customFieldName | String | Custom Field Name | Bug Causes |
| customFields[0].fieldCode | String | Custom Field Code | customfield_50776203 |
| customFields[0].fieldValue[0].name | String | Custom Field Option Value Name | Code Error |
| customFields[0].fieldValue[0].value | Object | Custom Field Option Value | 50776207 |
3. Information on comments
| Name | Type | Description | Example |
|---|---|---|---|
| comment.id | Long | Comment ID | 3 |
| comment.content | String | Comment Content | Comment Content |
| comment.type | String | Comment Type (Comment, Reply) | comment |
| comment.repliedld | Long | The id that war replied to | 4 |
4. Attachment information
| Name | Type | Description | Example |
|---|---|---|---|
| attachment.name | String | Attachment Name | Icon and image |
| attachment.extension | String | Attachment Extension Name | .jpg |
| attachment.updateBy.id | Long | Attachment Update By ID | 101 |
| attachment.updateBy.name | String | Attachment Update By Name | Bob |
| attachment.updateBy.email | String | Attachment Update By Email | bob.test@leiga.com |
| attachment.updateBy.phone | String | Attachment Update By Phone Number | 12345678901 |
| attachment.updateTime | Date | Attachment Update Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
5. Subtask Basic Information
| Name | Type | Description | Example |
|---|---|---|---|
| subtask.id | Long | Subtask ID | 100 |
| subtask.summary | String | Subtask Summary | Subtask Summary |
| subtask.status.id | Long | Subtask Workflow Status ID | 4 |
| subtask.status.name | String | Subtask Workflow Status Name | Done |
| subtask.status.category.id | Long | Subtask Workflow Status Type ID | 4 |
| subtask.status.category.name | String | Subtask Workflow Status Type Name | Done |
| subtask.status.code | String | Subtask Workflow Status Code | Done |
| subtask.startDate | Date | Subtask Start Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| subtask.dueDate | Date | Subtask Due Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| subtask.assignee.id | Long | Subtask Assignee ID | 101 |
| subtask.assignee.name | String | Subtask Assignee Name | Bob |
| subtask.assignee.email | String | Subtask Assignee Email | bob.test@leiga.com |
| subtask.assignee.phone | String | Subtask Assignee Name | 12345678901 |
| subtask.estimatePoint.value | BigDecimal | Subtask Estimated Point | 3 |
| subtask.labour.estimate | BigDecimal | Subtask Estimated Time | 7200 |
| subtask.labour.actual | BigDecimal | Subtask Time Spent | 3600 |
| subtask.labour.remaining | BigDecimal | Subtask Remaining | 3600 |
| subtask.createTime | Date | Subtask Create Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| subtask.updateTime | Date | Subtask Update Time | Applicable Functions: None Type: Long Description: Millisecond Timestamp Example: 1675041942307 Applicable Services: Leiga |
| subtask.createBy.id | Long | Subtask Create By ID | 101 |
| subtask.createBy.name | String | Subtask Create By Name | Bob |
| subtask.createBy.email | String | Subtask Create By Email | bob.test@leiga.com |
| subtask.createBy.phone | String | Subtask Create By Phone Number | 12345678901 |
| subtask.updateBy.id | Long | Subtask Update By ID | 101 |
| subtask.updateBy.name | String | Subtask Update By Name | Bob |
| subtask.updateBy.email | String | Subtask Update By Email | bob.test@leiga.com |
| subtask.updateBy.phone | String | Subtask Update By ID Phone Number | 12345678901 |
6. Information On Linked Work
| Name | Type | Description | Example |
|---|---|---|---|
| relationIssue.fromIssue.actionType | String | Change Operation of Linked Work | add |
| relationIssue.fromIssue.fromIssueId | String | Initiating Linked Work ID | 100 |
| relationIssue.destineIssues[0].destinationIssueId | Long | Targeting Linked Work ID | 100 |
| relationIssue.destineIssues[0].destinationProjectId | Long | Project ID of Targeting Linked Work | 900 |
| relationIssue.destineIssues[0].relationshipType | String | Type of Linked Work | BLOCKS |
7. Sprint information
| Name | Type | Description | Example |
|---|---|---|---|
| sprint.id | Long | Sprint ID | 1400 |
| sprint.name | String | Sprint Name | [Example] The name of the sprint |
| sprint.assignee | Long | Sprint Owner ID | 101 |
| sprint.assigneeName | String | Sprint Owner Name | Bob |
| sprint.startDate | Date | Sprint Start Time | 1675041942307 |
| sprint.endDate | Date | Sprint End Time | 1675041942307 |
| sprint.completeDate | Date | Sprnt Completion Time | 1675041942307 |
| sprint.started | Integer | Has Sprint Started (0: No, 1: Yes) | 1 |
| sprint.closed | Integer | Is Sprint Closed (0: No, 1: Yes) | 0 |
| print.goal | String | Sprint Goal | [Example] Sprint Goal |
| sprint.projectId | Long | Sprint Project ID | 900 |
| sprint.status | Long | Sprint Status (1: In progress, 2: Not started, 4: Completed) | 4 |
Field Name Variable
The system offers support for custom fields, allowing you to reference field names using variables. To do this, simply use the "field." prefix followed by the variable name of the data model. For more information, please consult the table provided:
| Name | Description | Example |
|---|---|---|
| field.base.issue | Field Name: Work | Work |
| field.issue.id | Field Name: Work ID | id |
| field.issue.summary | Field Name: Work Summary | Summary |
| field.issue.url | Field Name: Work Link | Link |
| field.issue.createTime | Field Name: Work Create Time | Create Time |
| field.issue.updateTime | Field Name: Work Update Time | Update Time |
| field.issue.description | Field Name: Work Description | Description |
| field.issue.startDate | Field Name: Work Start Time | Start Time |
| field.issue.dueDate | Field Name: Work Due Time | Due Time |
| field.issue.number | Field Name: Work Number | Number |
| field.issue.estimatePoint.value | Field Name: Work Estimated Points | Estimated Points |
| field.issue.labour.estimate | Field Name: Work Estimated Time | Estimated Time |
| field.issue.labour.actual | Field Name: Worth Time Spent | Time Spent |
| field.issue.labour.remaining | Field Name: Work Remaining | Remaining |
| field.issue.labour.totalActual | Field Name: Total Work Time Spent | Total Work Time Spent |
| field.issue.labour.totalRemaining | Field Name: Total Work Remaining | Total Remaining |
| field.issue.labour.totalEstimate | Field Name: Total Work Estimated Time | Total Estimated Time |
| field.issue.type.name | Field Name: Work Type Name | Type Name |
| field.issue.priority.name | Field Name: Work Priority | Priority |
| field.issue.status.name | Field Name: Workflow Status of Work | Status |
| field.issue.assignee.name | Field Name: Work Assignee | Assignee |
| field.issue.owner.name | Field Name: Work Owner | Owner |
| field.issue.createBy.name | Field Name: Work Created By | Create By |
| field.issue.updateBy.name | Field Name: Work Updated By | Update By |
| field.issue.sprint.name | Field Name: Sprint of the Work | Sprint |
| field.issue.releaseVersion.name | Field Name: Release of the Work | Release |
| field.issue.project.name | Field Name: Project Name | Project |
| field.subtask.id | Field Name: Subtask Primary Key | ID |
| field.subtask.status.name | Field Name: Subtask Workflow Status | Status |
| field.subtask.summary | Field Name: Subtask Summary | Summary |
| field.subtask.startDate | Field Name: Subtask Start Time | Start Time |
| field.subtask.dueDate | Field Name: Subtask Due Time | Due Time |
| field.subtask.assignee.name | Field Name: Subtask Assignee | Assignee |
| field.subtask.estimatePoint.value | Field Name: Subtask Estimated Points | Estimated Points |
| field.subtask.labour.estimate | Field Name: Subtask Estimated Time | Estimated Time |
| field.subtask.labour.actual | Field Name: Subtask Time Spent | Time Spent |
| field.subtask.labour.remaining | Field Name: Subtask Remaining | Remaining |
| field.subtask.labour.totalActual | Field Name: Total Subtask Time Spent | Total Time Spent |
| field.subtask.labour.totalRemaining | Field Name: Total Subtask Remaining | Total Remaining |
| field.subtask.labour.totalEstimate | Field Name: Total Subtask Estimated Time | Total Estimated Time |
| field.subtask.createTime | Field Name: Subtask Create Time | Create Time |
| field.subtask.updateTime | Field Name: Subtask Update Time | Update Time |
| field.subtask.createBy.name | Field Name: Subtask Created By | Create By |
| field.subtask.updateBy.name | Field Name: Subtask Updated By | Update By |
Information modules included in each event type
| Event Type | Data Model |
|---|---|
| Create Work Delete Work Update Work | Event Basic Information Work Information |
| Add Comment Update Comment Delete Comment | Event Basic Information Work Information Comment Information |
| Upload Attachment Delete Attachment | Event Basic Information Work Information Attachment Information |
| Add Subtask Update Subtask Delete Subtask | Event Basic Information Work Information Subtask Basic Information |
| Add Linked Work Delete Linked Work | Event Basic Information Information of Linked Work |
Create Sprint Start / Restart Sprint Complete Sprint Delete Sprint | Event Basic Information Sprint information |