CustomSchemaCreateV1

Occurs when a custom schema is created.

Webhook Payload

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

Property	Type	Description
id	string	Unique event id. The same event will have the same id
version	string	Event version
occurredAt	string	Timestamp of the event
tenantId	string	Tenant unique id (GUID)
tenantName	string	Tenant name
application	string	Application
productArea	string	Product area
data	object	The container of the event details data object details

data object details

Property	Type	Description
schemaId	string	Unique schema id (GUID)
schemaName	string	Schema name
schemaDescription	string	Schema description
status	N/A	Schema status
spaceIds	array	Space unique ids
fields	array of objects	Schema fields fields array object details
version	object	Version version object details
createdAt	string	Created at
updatedAt	string	Updated at

fields array object details

Property	Type	Description
schemaFieldId	string	Unique schema field id
optional	boolean	Is field optional
schemaFieldName	string	Schema field name
schemaFieldDescription	string	Schema field description
schemaFieldType	N/A	Schema field type
hasDomainOfValues	boolean	Has domain of values
allowMultipleValues	boolean	Allow multiple values
valueType	N/A	Value type
ext	['object', 'null']	Ext

version object details

Property	Type	Description
versionId	string	Unique version id
versionNumber	object	Version number versionNumber object details
previousVersionNumber	['object', 'null']	Previous version number
latest	boolean	Is latest version

versionNumber object details

Property	Type	Description
major	integer	Major version
minor	integer	Minor version
tag	string	Version tag

Example

{
  "id": "B5383B07D052882B25BAC391630F389C430631EF4370E7BD7A0A5F7969A7415A",
  "version": "CustomSchemaCreateV1",
  "occurredAt": "2024-04-28T14:05:45.398Z",
  "tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
  "tenantName": "demo",
  "data": {
    "schemaId": "4c082991-aa85-4c9e-b495-58cab85c56b0",
    "schemaName": "demo",
    "schemaDescription": "Demo for webhook",
    "status": "draft",
    "spaceIds": [],
    "fields": [
      {
        "schemaFieldId": "220705ac-4f7c-49bf-be3e-e949fc115b51",
        "optional": true,
        "schemaFieldName": "Name",
        "schemaFieldDescription": "",
        "schemaFieldType": "text",
        "hasDomainOfValues": false,
        "allowMultipleValues": false,
        "valueType": "string",
        "ext": {
          "possibleValues": [],
          "placeHolder": "Placeholder",
          "max": 2200,
          "min": 0
        }
      },
      {
        "schemaFieldId": "255daaee-5539-4620-bd41-7ba6936de353",
        "optional": true,
        "schemaFieldName": "IsSelected",
        "schemaFieldDescription": "",
        "schemaFieldType": "multiSelect",
        "hasDomainOfValues": true,
        "allowMultipleValues": true,
        "valueType": "array",
        "ext": {
          "possibleValues": [
            {
              "id": "5400faaf-69ae-4a7e-b4d2-514952a328b2",
              "name": "c#"
            },
            {
              "id": "7d66c540-bb51-4985-ad67-ae83a7152390",
              "name": "Typescript"
            }
          ],
          "placeHolder": null,
          "max": 2147483647,
          "min": 0
        }
      }
    ],
    "version": {
      "versionId": "ae012c47-63b7-45c9-b054-457ccf564b1c",
      "versionNumber": {
        "major": 1,
        "minor": 0,
        "tag": "v1.0"
      },
      "previousVersionNumber": null,
      "latest": true
    },
    "createdAt": "2024-04-28T14:05:44.514Z",
    "updatedAt": "2024-04-28T14:05:44.994Z"
  },
  "application": "CustomSchemaService",
  "productArea": "CustomContent"
}