Custom Property

Events that fire when a custom property definition changes.

Events

Event	When it fires
`custom_property.created`	A custom property is created on a custom object.
`custom_property.updated`	A custom property is updated.
`custom_property.deleted`	A custom property is deleted.

Examples

Each example is the full POST body Whippy sends, including the envelope fields data, api_version, event, created_at, and request_id.

`custom_property.created`

A custom property is created on a custom object.

{
  "data": {
    "id": "fab98e5a-9443-463a-8ddc-85b98b0edc36",
    "custom_object_id": "05ea44fb-9b0a-4455-bde5-17527d8f4b1c",
    "key": "city",
    "label": "City",
    "type": "text",
    "required": false,
    "default": null,
    "created_at": "2023-12-25T11:39:25",
    "updated_at": "2023-12-25T11:45:25"
  },
  "api_version": "v1",
  "event": "custom_property.created",
  "created_at": "2025-08-19T06:40:57.416929Z",
  "request_id": "29a73f67-1007-5bd7-ba64-4ceb7c3b5a24"
}

`custom_property.updated`

A custom property is updated.

{
  "data": {
    "id": "fab98e5a-9443-463a-8ddc-85b98b0edc36",
    "custom_object_id": "05ea44fb-9b0a-4455-bde5-17527d8f4b1c",
    "key": "street_name",
    "label": "Street Name",
    "type": "text",
    "required": true,
    "default": "1st Avenue",
    "created_at": "2023-12-25T11:39:25",
    "updated_at": "2023-12-25T11:45:25"
  },
  "api_version": "v1",
  "event": "custom_property.updated",
  "created_at": "2025-08-19T06:40:57.416929Z",
  "request_id": "874eb84a-0ae4-5d82-9610-abd9a260871d"
}

`custom_property.deleted`

A custom property is deleted.

{
  "data": {
    "id": "fab98e5a-9443-463a-8ddc-85b98b0edc36",
    "custom_object_id": "05ea44fb-9b0a-4455-bde5-17527d8f4b1c",
    "key": "notes",
    "label": "Notes",
    "type": "list",
    "required": true,
    "default": [
      "Note 1"
    ],
    "created_at": "2023-12-25T11:39:25",
    "updated_at": "2023-12-25T11:45:25"
  },
  "api_version": "v1",
  "event": "custom_property.deleted",
  "created_at": "2025-08-19T06:40:57.416929Z",
  "request_id": "22e1941d-606d-5d70-80da-f4bd2d6ff769"
}