Skip to main content

Webhook: ISSUE_EDITED

Overview​

The ISSUE_EDITED webhook is triggered when an existing issue is updated. This enables systems or users to be notified of changes, ensuring they can track updates and synchronize data as needed.

Purpose​

This webhook serves to inform relevant systems or stakeholders of modifications to issue details, such as changes in name, assignee, or other attributes, allowing for effective monitoring and management.

Request Format​

The webhook is sent as an HTTP POST request with the following JSON payload:

{
   "entityId": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
   "type": "ISSUE_EDITED",
   "createdAt": "2024-12-16T12:11:08.622Z",
   "data": {
      "operation": "UPDATE",
      "current": {
         "id": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue - New name",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      },
      "previous": {
         "id": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      }
   },
   "id": 201
}

Key Properties​

Top-Level Properties​

  • entityId: Unique identifier for the edited issue.
  • type: Specifies the webhook type (ISSUE_EDITED).
  • createdAt: Timestamp when the webhook was triggered (ISO 8601 format).
  • data: Contains details about the changes made to the issue.

Data Section​

General Details​

  • operation: Describes the operation performed on the issue (UPDATE in this case).

Current (Updated) Data​

  • id: Unique identifier of the issue.
  • organizationId: Identifier for the organization linked to the issue.
  • name: The updated name of the issue.
  • assigneeId: Identifier of the user currently assigned to the issue.
  • locationId: Identifier of the location associated with the issue.
  • createdBy: Identifier of the user who initially created the issue.

Previous (Original) Data​

  • id: Unique identifier of the issue (remains the same).
  • organizationId: Organization identifier before the update (unchanged here).
  • name: The original name of the issue before the update.
  • assigneeId: Original assignee ID before the change (if applicable).
  • locationId: Original location associated with the issue.
  • createdBy: Original creator of the issue.

Example Response​

A sample webhook payload representing an edited issue:

{
   "entityId": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
   "type": "ISSUE_EDITED",
   "createdAt": "2024-12-16T12:11:08.622Z",
   "data": {
      "operation": "UPDATE",
      "current": {
         "id": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue - New name",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      },
      "previous": {
         "id": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      }
   }
}

Benefits of ISSUE_EDITED Webhook​

  1. Enhanced Traceability: Tracks modifications to issue details, maintaining a clear history.
  2. Real-Time Updates: Ensures external systems are promptly updated about issue changes.
  3. Streamlined Coordination: Helps teams and stakeholders stay informed of any adjustments.

This webhook is particularly useful for maintaining data consistency across integrated systems.