CustomSchemaDeleteV1

Occurs when a custom schema is deleted.

Webhook Payload

The webhook event is encapsulated within a common wrapper structure providing general information about the event.

PropertyTypeDescription
idstringUnique event id. The same event will have the same id
versionstringEvent version
occurredAtstringTimestamp of the event
tenantIdstringTenant unique id (GUID)
tenantNamestringTenant name
applicationstringApplication
productAreastringProduct area
dataobjectThe container of the event details data object details

data object details

PropertyTypeDescription
schemaIdstringUnique schema id (GUID)
schemaNamestringSchema name
schemaDescriptionstringSchema description
statusN/ASchema status
spaceIdsarraySpace unique ids
fieldsarray of objectsSchema fields fields array object details
versionobjectVersion version object details
createdAtstringCreated at
updatedAtstringUpdated at

fields array object details

PropertyTypeDescription
schemaFieldIdstringUnique schema field id
optionalbooleanIs field optional
schemaFieldNamestringSchema field name
schemaFieldDescriptionstringSchema field description
schemaFieldTypeN/ASchema field type
hasDomainOfValuesbooleanHas domain of values
allowMultipleValuesbooleanAllow multiple values
valueTypeN/AValue type
ext['object', 'null']Ext

version object details

PropertyTypeDescription
versionIdstringUnique version id
versionNumberobjectVersion number versionNumber object details
previousVersionNumber['object', 'null']Previous version number
latestbooleanIs latest version

versionNumber object details

PropertyTypeDescription
majorintegerMajor version
minorintegerMinor version
tagstringVersion tag

Example

{
  "id": "6E1BA5A357E49757F62B48770BA2FA3130B374D1CEB2B6380A8E68E9B134A797",
  "version": "CustomSchemaDeleteV1",
  "occurredAt": "2024-04-28T14:37:03.734Z",
  "tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
  "tenantName": "demo",
  "data": {
    "schemaId": "6e950235-0105-4f73-a10b-f64c7e17f31d",
    "schemaName": "demo2",
    "schemaDescription": "",
    "status": "draft",
    "spaceIds": [],
    "fields": [
      {
        "schemaFieldId": "118a6155-eb26-4603-b213-f3f20d9a7f5e",
        "optional": true,
        "schemaFieldName": "name2",
        "schemaFieldDescription": "",
        "schemaFieldType": "text",
        "hasDomainOfValues": false,
        "allowMultipleValues": false,
        "valueType": "string",
        "ext": {
          "possibleValues": [],
          "placeHolder": "",
          "max": 2200,
          "min": 0
        }
      }
    ],
    "version": {
      "versionId": "b1fd8eee-921e-434a-8486-1ad9ac98f30c",
      "versionNumber": {
        "major": 1,
        "minor": 0,
        "tag": "v1.0"
      },
      "previousVersionNumber": null,
      "latest": true
    },
    "createdAt": "2024-04-28T14:35:37.923Z",
    "updatedAt": "2024-04-28T14:35:37.996Z"
  },
  "application": "CustomSchemaService",
  "productArea": "CustomContent"
}