Skip to main content
The ObjectSchemaUpdate event fires whenever an existing custom object schema is modified within an account. Modifications can include adding or removing searchable properties, renaming labels, or changing the primary display property. Use this event to detect schema drift, re-validate dependent integrations, or update downstream data mappings.

​
Payload

FieldTypeDescription
keystringUnique key identifying this object type, scoped to the location (e.g., "custom_objects.pet")
locationIdstringAccount ID where the schema was updated
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
searchablePropertiesarrayUpdated list of property keys that can be searched on records of this type
createdAtstringISO 8601 timestamp of when the schema was originally created
updatedAtstringISO 8601 timestamp of this update
createdByobjectIdentity of the user who originally created the schema
updatedByobjectIdentity of the user who made this update

​
Example payload

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