Web API

Press shift + S to search API reference.

Object

Webhooks table changed

Models that reference this object:

object

The presence of each created*, destroyed*, changed* field is determined by the specification filters and the actual change itself.

Previous and unchanged values are only a part of the payload if the specification contains them in the includes object.

{
"changedMetadata": {
"current": {
"name": "table name",
"description": "table description"
},
"previous": {
"name": "previous name",
"description": "previous name"
}
},
"createdFieldsById": {
"fld10000000000000": {
"name": "new name",
"type": "number"
}
},
"changedFieldsById": {
"fld10000000000001": {
"current": {
"name": "new name"
},
"previous": {
"name": "previous name"
}
},
"fld10000000000002": {
"current": {
"type": "number"
},
"previous": {
"type": "rating"
}
}
},
"destroyedFieldIds": [
"fld10000000000003"
],
"createdRecordsById": {
"rec00000000000000": {
"cellValuesByFieldId": {
"fld0000000000000": 0
},
"createdTime": "2022-02-01T21:25:05.663Z"
}
},
"changedRecordsById": {
"rec00000000000001": {
"current": {
"cellValuesByFieldId": {
"fld00000000000001": "hello world"
}
},
"previous": {
"cellValuesByFieldId": {
"fld0000000000001": "hello"
}
},
"unchanged": {
"cellValuesByFieldId": {
"fld0000000000000": 1
}
}
}
},
"destroyedRecordIds": [
"rec00000000000002"
],
"changedViewsById": {
"viw00000000000000": {
"createdRecordsById": {
"rec00000000000000": {
"cellValuesByFieldId": {
"fld00000000000000": 0
},
"createdTime": "2022-02-01T21:25:05.663Z"
}
},
"changedRecordsById": {
"rec00000000000001": {
"current": {
"cellValuesByFieldId": {
"fld00000000000001": "hello world"
}
},
"previous": {
"cellValuesByFieldId": {
"fld0000000000001": "hello"
}
},
"unchanged": {
"cellValuesByFieldId": {
"fld0000000000000": 1
}
}
}
},
"destroyedRecordIds": [
"rec00000000000002"
]
}
}
changedViewsById
optional<object>

This is only included when recordChangeScope is a view id.

The below object is keyed with a string
changedRecordsById
optional<Webhooks changed record>

Changed events are generated when a record in a view changes.

createdRecordsById
optional<Webhooks created record>

Create events when a record is added or made visible to a view.

destroyedRecordIds
optional<array of strings>

Destroyed events are generated when a record is deleted or removed from a view.

changedFieldsById
optional<object>
The below object is keyed with a string
current
object
type
optional<Field Type>
name
optional<string>
previous
optional<object>
type
optional<Field Type>
name
optional<string>
changedRecordsById
optional<Webhooks changed record>
createdFieldsById
optional<object>
The below object is keyed with a string
type
Field Type
name
string
createdRecordsById
optional<Webhooks created record>
changedMetadata
optional<object>
current
object
description
optional<string | null>
name
optional<string>
previous
object
description
optional<string | null>
name
optional<string>
destroyedFieldIds
optional<array of strings>
destroyedRecordIds
optional<array of strings>