Webhooks specification
object
A single webhook may watch changes in a table, view, or base. The specification defines the types of the changes that are included in the webhook's payloads.
Note that tables, fields, and views in the specification must be specified by ID rather than by name. You may find the IDs for each of these with the manage fields UI.
object A webhook specification can contain a filters object. For example, the specification for a webhook watching the data in a table is as follows:
The table events can be filtered down even more to cover just record data changes for certain fields from specific sources.
Aside from dataTypes, the keys in a filters object are optional. By default, a webhook will generate payloads across an entire base according to the specified dataTypes. We strongly recommend that your integration specify a filters object with a subset of the filter keys to ensure that your integration is notified for only the most relevant events.
| |||||||||||||||||||||||
optional< object > By default, the payloads only contain the data that changed. In order to generate payloads with more contextual data, an includes object may be added to the specification:
|