Object Schema Update | Webhook Events

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

Field	Type	Description
`key`	`string`	Unique key identifying this object type, scoped to the location (e.g., `"custom_objects.pet"`)
`locationId`	`string`	Account ID where the schema was updated
`primaryDisplayProperty`	`string`	The property key used as the primary display name for records of this type
`labels`	`object`	Human-readable names for the object type
`labels.singular`	`string`	Singular label for the object type (e.g., `"pet"`)
`labels.plural`	`string`	Plural label for the object type (e.g., `"pets"`)
`objectType`	`string`	Always `"USER_DEFINED"` for custom schemas
`searchableProperties`	`array`	Updated list of property keys that can be searched on records of this type
`createdAt`	`string`	ISO 8601 timestamp of when the schema was originally created
`updatedAt`	`string`	ISO 8601 timestamp of this update
`createdBy`	`object`	Identity of the user who originally created the schema
`updatedBy`	`object`	Identity 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"
}

Object Schema Create — fires when a new schema is defined
Record Update — fires when a record of a custom object type is modified
Objects API — manage custom object schemas and records

​Payload

​Example payload

​Related

Payload

Example payload

Related