Connect to external services with Workflow Webhooks

JSON options

For Workflow webhooks
The Request Body JSON can include values from the lists below.
Descriptions of content in the Request Body for iSheet and File Triggers based on Add/Update Operations:
Common Request body fields
  • instanceId : Refers to HighQ Collaborate Unique ID
  • instanceBaseUrl : Refers to HighQ Collaborate URL
  • timezone : Refers to HighQ Collaborate configured timezone
  • siteId : Refers to ID of Site in which Isheet/File operation is performed
  • workflowVersion : Refers to the current workflow version.
  • author: Refers to ID of User who has performed this Operation
  • moduleAlias : Refers to Module Alias of Isheet or File
iSheet Operation - Add/Edit
  • moduleAlias : SITE_MODULE_ISHEET
  • operation: EDIT_ITEM /ADD_ITEM
  • contentID : Refers to ID of Isheet record added or updated
  • isheetID : Refers to ID of Isheet on which Trigger was performed
  • columnIds: Refers to the column IDs the user selects in the 'Send to external services' action.
File Operation - Add/Edit
  • moduleAlias : SITE_MODULE_DOCUMENTS
  • operation: ACTIVITY_DOCUMENT_ADDED /ACTIVITY_VERSION_UPLOADED
  • contentID : Refers to ID of File record added or updated (when new file version is uploaded)
  • parentFolderId : Refers to ID of Folder in which File is added or updated
  • documentExtension : Refers to Type of File
Common Request body fields related to Workflow tracking
  • workflowId : Refers to the ID of Workflow present in the site where the rule is configured.
  • ruleId : Refers to ID of Rule present in Workflow.
  • ruleExecutionTimestamp : Refers to timestamp value when Rule is executed.
Versioning Strategy
Version 1 (V1)
  • Current Version: V1
  • Backward Compatibility: V1 is designed as the base version. It can accommodate to incorporate new changes without breaking existing integrations.
Version 2 (V2) and Beyond
  • Introduction of Breaking Changes: For any breaking changes that cannot be accommodated within the existing structure of V1, a new version (e.g., V2) will be introduced.
  • Backward Compatibility: Each new version will be designed to ensure backward compatibility for its lifecycle, with new features and improvements.
  • Deprecation Policy: Similar to V1, each version will be supported for 6 months after the release of a subsequent version. Only the last 2 versions will be supported at a time.
Example Scenarios
  • Adding New Parameters (Non-Breaking Change)
  • Scenario: Adding a new optional parameter to an existing endpoint.
  • Impact on V1: No impact. The new parameter will be optional, ensuring that existing integrations continue to function as before.
  • Action: Update V1 documentation to include the new parameter.
Introducing Breaking Changes (New Version)
  • Scenario: Changing the structure of the response object in a way that is not backwards compatible.
  • Impact on V1: Existing integrations would break if the change is introduced in V1.
  • Action: Introduce V2 with the new changes. Maintain V1 for 6 months to allow users to transition.
Transition Guidelines
  • Notification: Users will be notified well before the release of a new version and the deprecation of the old version.
  • Documentation: Comprehensive documentation will be provided for each version, highlighting changes, new features, and migration guidelines.
  • Support: During the 6-month transition period, support will be provided to assist users in migrating to the new version.
Trigger - When iSheet record is added
{
 "instanceId": "collabdev.1686832116640",
 "instanceBaseUrl": "https://collabdev.hqdev.highq.com/collabdev",
 "timeZone": "Asia/Calcutta",
 "siteId": 5,
 "workflowVersion": "23110",
 "workflowId": 1,
 "ruleId": 39,
 "ruleExecutionTimestamp": 1697712006438,
 "author": 100,
 "triggerDetail": {
  "v1": {
  "moduleAlias": "SITE_MODULE_ISHEET",
  "operation": "ADD_ITEM",
  "contentDetail": {
   "contentId": 111,
   "isheetId": 13,
   "columnIds": [
    111,
    222,
    333
    ]
    }
   }
  }
 }
Trigger - When iSheet record is updated
{
 "instanceId": "collabdev.1686832116640",
 "instanceBaseUrl": "https://collabdev.hqdev.highq.com/collabdev",
 "timeZone": "Asia/Calcutta",
 "siteId": 5,
 "workflowVersion": "23110",
 "workflowId": 1,
 "ruleId": 39,
 "ruleExecutionTimestamp": 1697712006438,
 "author": 100,
 "triggerDetail": {
  "v1": {
   "moduleAlias": "SITE_MODULE_ISHEET",
   "operation": "EDIT_ITEM",
   "contentDetail": {
    "contentId": 111,
    "isheetId": 13,
    "columnIds": [
     111,
     222,
     333
     ]
    }
   }
  }
 }
Trigger - File is added
{
 "instanceId": "collabdev.1686832116640",
 "instanceBaseUrl": "https://collabdev.hqdev.highq.com/collabdev",
 "timeZone": "Asia/Calcutta",
 "siteId": 5,
 "workflowVersion": "23110",
 "workflowId": 1,
 "ruleId": 54,
 "ruleExecutionTimestamp": 1697711405351,
 "author": 100,
 "triggerDetail": {
  "v1": {
   "moduleAlias": "SITE_MODULE_DOCUMENTS",
   "operation": "ACTIVITY_DOCUMENT_ADDED",
   "contentDetail": {
    "contentId": 8,
    "parentFolderId": 26,
    "documentExtension": "png"
    }
   }
  }
 }
Trigger - File is updated (New file version is uploaded)
{ 
"instanceId": "collabdev.1686832116640",
 "instanceBaseUrl": "https://collabdev.hqdev.highq.com/collabdev",
 "timeZone": "Asia/Calcutta",
 "siteId": 5,
 "workflowVersion": "23110",
 "workflowId": 1,
 "ruleId": 54,
 "ruleExecutionTimestamp": 1697711405351,
 "author": 100,
 "triggerDetail": {
  "v1": {
   "moduleAlias": "SITE_MODULE_DOCUMENTS",
   "operation": "ACTIVITY_VERSION_UPLOADED",
   "contentDetail": {
    "contentId": 8,
    "parentFolderId": 26,
    "documentExtension": "png"
    }
   }
  }
 }

This article applies to:

  • Product: HighQ
  • Subject: Workflow

Related content