Skip to main content

Webhook: ACTION_MISSED_REQUIRED

Overview​

The ACTION_MISSED_REQUIRED webhook is triggered when a required action for a task is not performed at the appropriate time. This notification ensures that users or systems are informed about such missed actions, enabling them to address the issue and prevent potential disruptions.

Purpose​

This webhook provides timely alerts for missed critical actions, ensuring accountability and enabling corrective measures. It is particularly useful for tracking mandatory steps in task management workflows or time-sensitive operations.

Request Format​

The webhook sends an HTTP POST request with the following JSON payload:

{
   "entityId": "c2b700c6-169b-429b-93e2-cbdc9d11f9d3",
   "type": "ACTION_MISSED_REQUIRED",
   "createdAt": "2024-12-16T13:00:01.448Z",
   "data": {
      "id": "c2b700c6-169b-429b-93e2-cbdc9d11f9d3",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T13:00:00.000Z",
      "endAt": "2024-12-16T14:00:00.000Z",
      "name": "Task 4",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": "0fa9feb3-6405-4d93-9e7e-9ccc91aadb60",
      "actionId": "cf5a70b6-3672-423c-8467-55c988715625"
   },
   "id": 201
}

Main Properties​

Top-Level Fields​

  • entityId: Unique identifier for the missed action event.
  • type: Specifies the webhook type (ACTION_MISSED_REQUIRED).
  • createdAt: Timestamp of when the webhook was created, in ISO 8601 format.
  • data: Contains detailed information about the missed action.

Data Fields​

Action Details​

  • id: Unique identifier for the specific action.
  • organizationId: Identifier for the organization associated with the action.
  • locationId: Identifier for the location where the action was missed.
  • startAt: Scheduled start time of the action, in ISO 8601 format.
  • endAt: Scheduled end time of the action, in ISO 8601 format.
  • name: Name of the task associated with the missed action.
  • assigneeIds: List of IDs for users assigned to this task or action.
  • recurrenceRule: Recurrence rules for the task (if applicable). For this event, this field is null.
  • stepId: Identifier of the specific step associated with the action.
  • actionId: Identifier of the action that was missed.

Example Response​

A sample payload for a successful webhook trigger:

{
   "entityId": "c2b700c6-169b-429b-93e2-cbdc9d11f9d3",
   "type": "ACTION_MISSED_REQUIRED",
   "createdAt": "2024-12-16T13:00:01.448Z",
   "data": {
      "id": "c2b700c6-169b-429b-93e2-cbdc9d11f9d3",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T13:00:00.000Z",
      "endAt": "2024-12-16T14:00:00.000Z",
      "name": "Task 4",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": "0fa9feb3-6405-4d93-9e7e-9ccc91aadb60",
      "actionId": "cf5a70b6-3672-423c-8467-55c988715625"
   }
}

Benefits​

  1. Timely Notifications: Ensures stakeholders are promptly informed about missed actions.
  2. Error Mitigation: Enables corrective actions before delays or issues escalate.
  3. Accountability: Helps track and address responsibility for missed actions.
  4. Improved Workflow: Enhances task management by identifying bottlenecks or missed steps.

The ACTION_MISSED_REQUIRED webhook is a critical tool for maintaining task completion integrity and ensuring smooth operations in workflows.