Skip to main content

Webhook: ACTION_SPECIFIED_ OUT_OF_RANGE_NUMBER

Overview​

The ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER webhook is triggered when a numeric action exceeds its predefined range (e.g., a temperature value exceeding its safe limit). This webhook helps monitor such events, enabling systems or users to take corrective measures to avoid potential issues.

Purpose​

This webhook serves as a notification system to alert users or systems when numerical values exceed acceptable limits. Examples include tracking equipment performance (e.g., temperature, pressure) or other scenarios where exceeding a range might cause errors or failures.

Request Format​

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

{
   "entityId": "8d894ccc-66aa-41db-8101-f1e8c162688b",
   "type": "ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER",
   "createdAt": "2024-12-16T12:24:02.313Z",
   "data": {
      "id": "8d894ccc-66aa-41db-8101-f1e8c162688b",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T12:00:00.000Z",
      "endAt": "2024-12-16T13:00:00.000Z",
      "name": "Task 4",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": "8f7882dd-16e9-4354-8284-b5ad22bf2ea9",
      "actionId": "c57bf98e-ddd5-440a-a2ff-9f395f81e850"
   },
   "id": 201
}

Key Properties​

Top-Level Fields​

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

Data Fields​

Action Details​

  • id: Unique identifier for the specific action.
  • organizationId: Identifier for the organization linked to the action.
  • locationId: Identifier for the location where the action took place.
  • startAt: The start time of the action in ISO 8601 format.
  • endAt: The end time of the action in ISO 8601 format.
  • name: The name of the task associated with the action.
  • assigneeIds: List of user IDs assigned to this task or action.
  • recurrenceRule: Recurrence rules for the task (if any). For this event, this field is null.
  • stepId: Identifier of the specific step associated with the action.
  • actionId: Identifier for the action that triggered the out-of-range error.

Example Response​

A sample payload for a successful webhook trigger:

{
   "entityId": "8d894ccc-66aa-41db-8101-f1e8c162688b",
   "type": "ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER",
   "createdAt": "2024-12-16T12:24:02.313Z",
   "data": {
      "id": "8d894ccc-66aa-41db-8101-f1e8c162688b",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T12:00:00.000Z",
      "endAt": "2024-12-16T13:00:00.000Z",
      "name": "Task 4",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": "8f7882dd-16e9-4354-8284-b5ad22bf2ea9",
      "actionId": "c57bf98e-ddd5-440a-a2ff-9f395f81e850"
   }
}

Benefits​

  1. Error Prevention: Helps mitigate risks by notifying stakeholders when numerical values go beyond acceptable limits.
  2. Automated Monitoring: Allows systems to react automatically to out-of-range values, triggering corrective actions or alerts.
  3. Enhanced Visibility: Keeps users informed about potential issues, improving oversight and management.

The ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER webhook provides an essential monitoring mechanism to ensure numerical values remain within predefined safe boundaries.