This page contains the schema, and an example, for every type of Webhook that we currently send. For more information about setting up and handling Webhooks, please check out our using webhooks guide.
This event is fired whenever a Comment is created.
id
object
REQUIRED
actor
object
REQUIRED
list_id
string | null
REQUIRED
If the Comment relates to a List Entry, this is the ID of that List, otherwise null.
entry_id
string | null
REQUIRED
If the Comment relates to a List Entry, this is the ID of that List Entry, otherwise null.
object_id
string
REQUIRED
The ID of the Object that the Comment relates to.
Format: UUID
record_id
string
REQUIRED
The ID of the Record that the Comment relates to.
Format: UUID
thread_id
string
REQUIRED
The ID of the Thread that the Comment belongs to.
Format: UUID
event_type
enum
REQUIRED
comment.created
This event is fired whenever a Comment is deleted.
id
object
REQUIRED
actor
object
REQUIRED
list_id
string | null
REQUIRED
If the Comment relates to a List Entry, this is the ID of that List, otherwise null.
entry_id
string | null
REQUIRED
If the Comment relates to a List Entry, this is the ID of that List Entry, otherwise null.
object_id
string
REQUIRED
The ID of the Object that the Comment relates to.
Format: UUID
record_id
string
REQUIRED
The ID of the Record that the Comment relates to.
Format: UUID
thread_id
string
REQUIRED
The ID of the Thread that the Comment belongs to.
Format: UUID
event_type
enum
REQUIRED
comment.deleted
This event is fired whenever a Comment is resolved.
id
object
REQUIRED
actor
object
REQUIRED
list_id
string | null
REQUIRED
If the Comment relates to a List Entry, this is the ID of that List, otherwise null.
entry_id
string | null
REQUIRED
If the Comment relates to a List Entry, this is the ID of that List Entry, otherwise null.
object_id
string
REQUIRED
The ID of the Object that the Comment relates to.
Format: UUID
record_id
string
REQUIRED
The ID of the Record that the Comment relates to.
Format: UUID
thread_id
string
REQUIRED
The ID of the Thread that the Comment belongs to.
Format: UUID
event_type
enum
REQUIRED
comment.resolved
This event is fired whenever a Comment is un-resolved.
id
object
REQUIRED
actor
object
REQUIRED
list_id
string | null
REQUIRED
If the Comment relates to a List Entry, this is the ID of that List, otherwise null.
entry_id
string | null
REQUIRED
If the Comment relates to a List Entry, this is the ID of that List Entry, otherwise null.
object_id
string
REQUIRED
The ID of the Object that the Comment relates to.
Format: UUID
record_id
string
REQUIRED
The ID of the Record that the Comment relates to.
Format: UUID
thread_id
string
REQUIRED
The ID of the Thread that the Comment belongs to.
Format: UUID
event_type
enum
REQUIRED
comment.unresolved
This event is fired whenever a List Attribute is created (e.g. adding an "Owner" attribute).
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
list-attribute.created
This event is fired whenever a List Attribute is updated (e.g. when changing the name of the "Owner" attribute to "Proprietor").
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
list-attribute.updated
This event is fired whenever a List is created.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
list.created
This event is fired whenever a List is deleted.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
list.deleted
This event is fired whenever a List Entry is created (i.e. when a Record is added to a List).
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
parent_object_id
string
REQUIRED
The ID of the parent Object of the created List Entry.
Format: UUID
parent_record_id
string
REQUIRED
The ID of the parent Record of the created List Entry.
Format: UUID
list-entry.created
This event is fired whenever a List Entry is deleted (i.e. when a Record is removed from a List).
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
parent_object_id
string
REQUIRED
The ID of the parent Object of the deleted List Entry.
Format: UUID
parent_record_id
string
REQUIRED
The ID of the parent Record of the deleted List Entry.
Format: UUID
list-entry.deleted
This event is fired whenever an existing List Entry is updated (i.e. when a List Attribute is changed for a specific List Entry, e.g. when setting "Owner").
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
parent_object_id
string
REQUIRED
The ID of the parent Object of the updated List Entry.
Format: UUID
parent_record_id
string
REQUIRED
The ID of the parent Record of the updated List Entry.
Format: UUID
list-entry.updated
This event is fired whenever a List is updated (e.g. when changing the name or icon of the List).
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
list.updated
This event is fired whenever a Note is created. The `parent_object_id` refers to the Object that the Note references (e.g. the person object), and the `parent_record_id` refers to the Record that the Note references.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
parent_object_id
string
REQUIRED
The ID of the parent Object of the created Note.
Format: UUID
parent_record_id
string
REQUIRED
The ID of the parent Record of the created Note.
Format: UUID
note.created
This event is fired whenever a Note is deleted.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
parent_object_id
string
REQUIRED
The ID of the parent Object of the deleted Note.
Format: UUID
parent_record_id
string
REQUIRED
The ID of the parent Record of the deleted Note.
Format: UUID
note.deleted
This event is fired whenever the title of a Note is modified. Body updates do not currently trigger webhooks.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
parent_object_id
string
REQUIRED
The ID of the parent Object of the updated Note.
Format: UUID
parent_record_id
string
REQUIRED
The ID of the parent Record of the updated Note.
Format: UUID
note.updated
This event is fired whenever an Object Attribute is created (e.g. when defining a new Attribute "Rating" on the company Object).
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
object-attribute.created
This event is fired whenever an Object Attribute is updated (e.g. when renaming the "Rating" attribute to "Score" on the company Object).
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
object-attribute.updated
This event is fired whenever a Record is created.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
record.created
This event is fired whenever a Record is deleted.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
record.deleted
This event is fired whenever two Records are merged together. Merging copies properties from the "duplicate" Record into the original Record, so that the original Record has the properties of both, and the duplicate Record is deleted.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
duplicate_object_id
string
REQUIRED
The ID of the Object that was merged into the other
Format: UUID
duplicate_record_id
string
REQUIRED
The ID of the Record that was merged into the other
Format: UUID
record.merged
This event is fired whenever an Attribute on a Record is updated (e.g. changing the "name" field on a Record).
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
record.updated
This event is fired whenever a Task is created.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
task.created
This event is fired whenever a Task is deleted.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
task.deleted
This event is fired whenever a Task is updated (e.g. the assignees or deadline are changed).
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
task.updated
This event is fired whenever a Workspace Member is added to the Workspace.
id
object
REQUIRED
actor
object
REQUIRED
event_type
enum
REQUIRED
workspace-member.created