Skip to main content

Webhook: ISSUE_CREATED

Overview​

The ISSUE_CREATED webhook triggers when a new issue is successfully created in the system. It sends a notification containing detailed information about the issue, such as its name, assigned user, and associated organization. This helps systems and users monitor and manage new issues effectively.

Purpose​

The webhook is designed to notify stakeholders or systems about the creation of an issue in real-time. This ensures newly created issues are quickly identified, tracked, and acted upon as needed.

Request Format​

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

{
   "entityId": "decd63dd-50e8-43c5-b467-965402c0575b",
   "type": "ISSUE_CREATED",
   "createdAt": "2024-12-16T12:14:15.029Z",
   "data": {
      "operation": "INSERT",
      "current": {
         "id": "decd63dd-50e8-43c5-b467-965402c0575b",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue 2",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      },
      "previous": null
   },
   "id": 201
}

Key Properties​

Top-Level Fields​

  • entityId: Unique identifier for the issue.
  • type: Specifies the webhook type (ISSUE_CREATED).
  • createdAt: Timestamp of the webhook trigger in ISO 8601 format.
  • data: Contains the details of the newly created issue.

Data Fields​

Operation​

  • operation: Describes the action performed. For newly created issues, this is always INSERT.

Current (New Issue) Data​

  • id: Unique identifier for the issue.
  • organizationId: Identifier for the organization associated with the issue.
  • name: Name or title of the issue.
  • assigneeId: Identifier of the user assigned to the issue.
  • locationId: Identifier of the issue's location.
  • createdBy: Identifier of the user who created the issue.

Previous​

  • previous: Data of the issue before the current operation. For new issues, this field is always null.

Example Response​

A sample payload for a successful webhook trigger:

{
   "entityId": "decd63dd-50e8-43c5-b467-965402c0575b",
   "type": "ISSUE_CREATED",
   "createdAt": "2024-12-16T12:14:15.029Z",
   "data": {
      "operation": "INSERT",
      "current": {
         "id": "decd63dd-50e8-43c5-b467-965402c0575b",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue 2",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      },
      "previous": null
   }
}

Benefits​

  1. Real-Time Notifications: Systems and users can be instantly informed of new issues for timely action.
  2. Automated Workflow Integration: Helps automate downstream processes such as task assignment, notifications, or logging.
  3. Centralized Tracking: Ensures all issues are logged with complete details, facilitating seamless issue management.

The ISSUE_CREATED webhook is an essential tool for maintaining efficient workflows and robust issue management.