Webhooks

5.9 Surveys

The Survey template is currently very light. This will be updated in the near future as surveys are re-implemented.

Survey Template

{

    "id": <int>,

    "surveyTypeId": <int>

    "title": <string>,

       "tag":<string>,

    "description": <string>,

    "effectiveTo": <string ISO 8601 Date>,

    "createdAt": <string ISO 8601 Date>,

       "createdByPersonId": <int>,

}

Json Schema (for use with MS Power Automate)

{
  "type": "object",
  "properties": {
    "subjectType": {
      "type": "string"
    },
    "changeType": {
      "type": "string"
    },
    "subjectFrontEndUrl": {
      "type": "string"
    },
    "timeStamp": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "surveyTypeId": {
          "type": "integer"
        },
        "surveyType": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "tag": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "effectiveFrom": {
          "type": "string"
        },
        "effectiveTo": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "createdByPerson": {
          "type": "object",
          "properties": {
            "PersonId": {
              "type": "integer"
            },
            "FirstName": {
              "type": "string"
            },
            "FamilyName": {
              "type": "string"
            },
            "Email": {
              "type": "string"
            }
          }
        },
        "modifiedAt": {
          "type": "string"
        },
        "modifiedByPerson": {
          "type": "object",
          "properties": {
            "PersonId": {
              "type": "integer"
            },
            "FirstName": {
              "type": "string"
            },
            "FamilyName": {
              "type": "string"
            },
            "Email": {
              "type": "string"
            }
          }
        },
        "notificationSettings": {
          "type": "object",
          "properties": {
            "push": {
              "type": "boolean"
            },
            "sms": {
              "type": "boolean"
            },
            "email": {
              "type": "boolean"
            },
            "microsoftTeams": {
              "type": "boolean"
            },
            "inApp": {
              "type": "boolean"
            }
          }
        },
        "contentSettings": {
          "type": "object",
          "properties": {
            "allowLikes": {
              "type": "boolean"
            },
            "allowComments": {
              "type": "boolean"
            },
            "allowImagesInComments": {
              "type": "boolean"
            },
            "allowDocuments": {
              "type": "boolean"
            }
          }
        },
        "relatedItem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "title": {
              "type": "string"
            },
            "type": {
              "type": "integer"
            },
            "url": {
              "type": "string"
            }
          }
        },
        "isDeleted": {
          "type": "boolean"
        }
      }
    },
    "differences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "oldValue": {
            "type": "string"
          },
          "newValue": {
            "type": "string"
          }
        },
        "required": [
          "path",
          "oldValue",
          "newValue"
        ]
      }
    }
  }
}