List of Webhooks v2

Every webhooks v2 subscription combines an event action (what happened) with one or more event objects (what it happened to). This page lists the values you can use for each.

Event actions

Event action	API value	Triggered when...
All	`*`	...any of the actions below happens.
Create	`create`	...a new object is added to your account.
Change	`change`	...any parameter of an existing object is updated. This covers every kind of edit, so moving a deal to another stage and renaming it both send a `change` notification.
Delete	`delete`	...an object is deleted.

Event objects

Any of these values can be paired with any event action.

Event object	API value	Notifies you about
All	`*`	Every object listed below
Activity	`activity`	Activities
Board	`board`	Project boards
Deal	`deal`	Deals
Deal field	`deal_field`	Deal field definitions
Deal installment	`deal_installment`	Installments on a deal
Deal product	`deal_product`	Products attached to a deal
Lead	`lead`	Leads
Lead field	`lead_field`	Lead field definitions
Note	`note`	Notes
Organization	`organization`	Organizations
Organization field	`organization_field`	Organization field definitions
Person	`person`	Persons
Person field	`person_field`	Person field definitions
Phase	`phase`	Phases within a project board
Pipeline	`pipeline`	Pipelines
Product	`product`	Products
Product field	`product_field`	Product field definitions
Project	`project`	Projects
Project field	`project_field`	Project field definitions
Stage	`stage`	Stages within a pipeline
Task	`task`	Tasks within a project
User	`user`	Users in your company

📘
The *_field objects notify you about changes to field definitions — a field being added, renamed, or removed, or its options changing. To be notified when the value of a field on a record changes, subscribe to that record's object instead, such as deal or person.

To learn how to combine these values into a subscription, see the guide for webhooks v2.

Updated 16 days ago

Did this page help you?