Skip to main content
The ObjectSchemaCreate event fires when a user defines a new custom object type within an account. Custom object schemas establish the structure — labels, searchable properties, and display rules — for any user-defined data model. Subscribe to this event to react to new data models being introduced, provision related resources, or audit schema changes across accounts.

​
Payload

FieldTypeDescription
keystringUnique key identifying this object type, scoped to the location (e.g., "custom_objects.pet")
locationIdstringAccount ID where the schema was created
primaryDisplayPropertystringThe property key used as the primary display name for records of this type
labelsobjectHuman-readable names for the object type
labels.singularstringSingular label for the object type (e.g., "pet")
labels.pluralstringPlural label for the object type (e.g., "pets")
objectTypestringAlways "USER_DEFINED" for custom schemas
searchablePropertiesarrayList of property keys that can be searched on records of this type
createdAtstringISO 8601 timestamp of when the schema was created
updatedAtstringISO 8601 timestamp of the last schema modification
createdByobjectIdentity of the user who created the schema
updatedByobjectIdentity of the user who last modified the schema

​
Example payload

{
  "key": "custom_objects.pet",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "primaryDisplayProperty": "pet_name",
  "labels": {
    "singular": "pet",
    "plural": "pets"
  },
  "objectType": "USER_DEFINED",
  "searchableProperties": ["pet_name"],
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}
Last modified on March 5, 2026