WebhooksWebhook events catalogue
Webhook events catalogue
Every event a webhook can subscribe to, generated from the API's own list: 138 events across 26 entities, with the GraphQL name of each.
Answer
A webhook subscribes to any of 138 events: the global *, and for each of 26 entities its all-events form such as Opportunity.*, plus Create, Update, Delete and business actions such as Opportunity.Won. GraphQL writes them without the dot: OpportunityWon, OpportunityAll, All. Custom entities use CustomEntity.*; tags, fields, pipelines, users and documents have no events.
The list below is generated from the API's own event list in the published OpenAPI spec, so it
holds every event there is. Subscribe to events in a webhook's events; in GraphQL use the name
in the last column.
Events
Filter by entity, or search by name:
| Event | Fires when | GraphQL |
|---|---|---|
* | Any event of any entity | All |
Account. | Any event for this entity | AccountAll |
Account. | A record is created | AccountCreate |
Account. | A record is deleted (soft delete) | AccountDelete |
Account. | A document is attached; it arrives as related_entity | AccountDocumentLinked |
Account. | The owner changes | AccountOwnerChanged |
Account. | A record is updated | AccountUpdate |
ActivityRelation. | Any event for this entity | ActivityRelationAll |
ActivityRelation. | A record is created | ActivityRelationCreate |
ActivityRelation. | A record is deleted (soft delete) | ActivityRelationDelete |
ActivityRelation. | A record is updated | ActivityRelationUpdate |
Appointment. | Any event for this entity | AppointmentAll |
Appointment. | A comment is added | AppointmentComment |
Appointment. | A record is created | AppointmentCreate |
Appointment. | A record is deleted (soft delete) | AppointmentDelete |
Appointment. | A document is attached; it arrives as related_entity | AppointmentDocumentLinked |
Appointment. | The owner changes | AppointmentOwnerChanged |
Appointment. | A record is updated | AppointmentUpdate |
Contact. | Any event for this entity | ContactAll |
Contact. | A record is created | ContactCreate |
Contact. | A record is deleted (soft delete) | ContactDelete |
Contact. | A document is attached; it arrives as related_entity | ContactDocumentLinked |
Contact. | The owner changes | ContactOwnerChanged |
Contact. | A record is updated | ContactUpdate |
ContactAccountRelation. | Any event for this entity | ContactAccountRelationAll |
ContactAccountRelation. | A record is created | ContactAccountRelationCreate |
ContactAccountRelation. | A record is deleted (soft delete) | ContactAccountRelationDelete |
ContactAccountRelation. | A record is updated | ContactAccountRelationUpdate |
Currency. | Any event for this entity | CurrencyAll |
Currency. | A record is created | CurrencyCreate |
Currency. | A record is deleted (soft delete) | CurrencyDelete |
Currency. | A record is updated | CurrencyUpdate |
CurrencyExchangeRate. | Any event for this entity | CurrencyExchangeRateAll |
CurrencyExchangeRate. | A record is created | CurrencyExchangeRateCreate |
CurrencyExchangeRate. | A record is deleted (soft delete) | CurrencyExchangeRateDelete |
CurrencyExchangeRate. | A record is updated | CurrencyExchangeRateUpdate |
CurrencyExchangeRatesList. | Any event for this entity | CurrencyExchangeRatesListAll |
CurrencyExchangeRatesList. | A record is created | CurrencyExchangeRatesListCreate |
CurrencyExchangeRatesList. | A record is deleted (soft delete) | CurrencyExchangeRatesListDelete |
CurrencyExchangeRatesList. | A record is updated | CurrencyExchangeRatesListUpdate |
CustomEntity. | Any event for this entity | CustomEntityAll |
CustomEntity. | A record is created | CustomEntityCreate |
CustomEntity. | A record is deleted (soft delete) | CustomEntityDelete |
CustomEntity. | A document is attached; it arrives as related_entity | CustomEntityDocumentLinked |
CustomEntity. | The owner changes | CustomEntityOwnerChanged |
CustomEntity. | A record is updated | CustomEntityUpdate |
Email. | Any event for this entity | EmailAll |
Email. | A record is created | EmailCreate |
Email. | A record is deleted (soft delete) | EmailDelete |
Email. | A document is attached; it arrives as related_entity | EmailDocumentLinked |
Email. | A record is updated | EmailUpdate |
Lead. | Any event for this entity | LeadAll |
Lead. | An opportunity is turned back into a lead | LeadBackToLead |
Lead. | A record is created | LeadCreate |
Lead. | A record is deleted (soft delete) | LeadDelete |
Lead. | A document is attached; it arrives as related_entity | LeadDocumentLinked |
Lead. | Marked as lost | LeadLost |
Lead. | The owner changes | LeadOwnerChanged |
Lead. | A record is updated | LeadUpdate |
LeadOpptyAccountRelation. | Any event for this entity | LeadOpptyAccountRelationAll |
LeadOpptyAccountRelation. | A record is created | LeadOpptyAccountRelationCreate |
LeadOpptyAccountRelation. | A record is deleted (soft delete) | LeadOpptyAccountRelationDelete |
LeadOpptyAccountRelation. | A record is updated | LeadOpptyAccountRelationUpdate |
LeadOpptyContactRelation. | Any event for this entity | LeadOpptyContactRelationAll |
LeadOpptyContactRelation. | A record is created | LeadOpptyContactRelationCreate |
LeadOpptyContactRelation. | A record is deleted (soft delete) | LeadOpptyContactRelationDelete |
LeadOpptyContactRelation. | A record is updated | LeadOpptyContactRelationUpdate |
Memo. | Any event for this entity | MemoAll |
Memo. | A comment is added | MemoComment |
Memo. | A record is created | MemoCreate |
Memo. | A record is deleted (soft delete) | MemoDelete |
Memo. | A document is attached; it arrives as related_entity | MemoDocumentLinked |
Memo. | A record is updated | MemoUpdate |
Message. | Any event for this entity | MessageAll |
Message. | A record is created | MessageCreate |
Message. | A record is deleted (soft delete) | MessageDelete |
Message. | A document is attached; it arrives as related_entity | MessageDocumentLinked |
Message. | A record is updated | MessageUpdate |
Note. | Any event for this entity | NoteAll |
Note. | A record is created | NoteCreate |
Note. | A record is deleted (soft delete) | NoteDelete |
Note. | A record is updated | NoteUpdate |
Opportunity. | Any event for this entity | OpportunityAll |
Opportunity. | A record is created | OpportunityCreate |
Opportunity. | A record is deleted (soft delete) | OpportunityDelete |
Opportunity. | A document is attached; it arrives as related_entity | OpportunityDocumentLinked |
Opportunity. | Marked as lost | OpportunityLost |
Opportunity. | Moves to another step, including when it is won | OpportunityMove |
Opportunity. | The owner changes | OpportunityOwnerChanged |
Opportunity. | A lead is qualified into this opportunity | OpportunityQualify |
Opportunity. | A record is updated | OpportunityUpdate |
Opportunity. | Marked as won | OpportunityWon |
OpptyProductRelation. | Any event for this entity | OpptyProductRelationAll |
OpptyProductRelation. | A record is created | OpptyProductRelationCreate |
OpptyProductRelation. | A record is deleted (soft delete) | OpptyProductRelationDelete |
OpptyProductRelation. | A record is updated | OpptyProductRelationUpdate |
Product. | Any event for this entity | ProductAll |
Product. | A record is created | ProductCreate |
Product. | A record is deleted (soft delete) | ProductDelete |
Product. | A record is updated | ProductUpdate |
ProductPriceList. | Any event for this entity | ProductPriceListAll |
ProductPriceList. | A record is created | ProductPriceListCreate |
ProductPriceList. | A record is deleted (soft delete) | ProductPriceListDelete |
ProductPriceList. | A record is updated | ProductPriceListUpdate |
ProductPriceListPrice. | Any event for this entity | ProductPriceListPriceAll |
ProductPriceListPrice. | A record is created | ProductPriceListPriceCreate |
ProductPriceListPrice. | A record is deleted (soft delete) | ProductPriceListPriceDelete |
ProductPriceListPrice. | A record is updated | ProductPriceListPriceUpdate |
Project. | Any event for this entity | ProjectAll |
Project. | A record is created | ProjectCreate |
Project. | A record is deleted (soft delete) | ProjectDelete |
Project. | A document is attached; it arrives as related_entity | ProjectDocumentLinked |
Project. | The owner changes | ProjectOwnerChanged |
Project. | A record is updated | ProjectUpdate |
Quote. | Any event for this entity | QuoteAll |
Quote. | A record is created | QuoteCreate |
Quote. | A record is deleted (soft delete) | QuoteDelete |
Quote. | A document is attached; it arrives as related_entity | QuoteDocumentLinked |
Quote. | Marked as lost | QuoteLost |
Quote. | Moves to another step, including when it is won | QuoteMove |
Quote. | The owner changes | QuoteOwnerChanged |
Quote. | A record is updated | QuoteUpdate |
Quote. | Marked as won | QuoteWon |
QuoteAccountRelation. | Any event for this entity | QuoteAccountRelationAll |
QuoteAccountRelation. | A record is created | QuoteAccountRelationCreate |
QuoteAccountRelation. | A record is deleted (soft delete) | QuoteAccountRelationDelete |
QuoteAccountRelation. | A record is updated | QuoteAccountRelationUpdate |
QuoteContactRelation. | Any event for this entity | QuoteContactRelationAll |
QuoteContactRelation. | A record is created | QuoteContactRelationCreate |
QuoteContactRelation. | A record is deleted (soft delete) | QuoteContactRelationDelete |
QuoteContactRelation. | A record is updated | QuoteContactRelationUpdate |
Task. | Any event for this entity | TaskAll |
Task. | A comment is added | TaskComment |
Task. | A record is created | TaskCreate |
Task. | A record is deleted (soft delete) | TaskDelete |
Task. | A document is attached; it arrives as related_entity | TaskDocumentLinked |
Task. | The owner changes | TaskOwnerChanged |
Task. | A record is updated | TaskUpdate |
138 events
How the names work
*subscribes to every event of every entity below;Opportunity.*to every event of one entity.- Create, Update and Delete exist for every entity. A delete is a soft delete: the record can be restored.
- Winning an opportunity or a quote also sends its
Moveevent, so a webhook on both receives two events for one win. - A webhook can also narrow an event to some records or to changes of some fields: filtering and options.
Custom entities
Subscribe to CustomEntity.* or one of its actions, not to CE_YourEntity.*. The event covers
every custom entity in the space; narrow it with options.custom_entity_api_name, a list of the
custom entities' API names, such as ["CE_Shipment"].
Documents
A document attached to a record arrives as that record's DocumentLinked event, such as
Opportunity.DocumentLinked, with the document in related_entity. Documents have no events of
their own.
Entities without events
No events for these
Tags, fields, forms, pipelines, steps, sales units, users, roles, online forms and documents send no events. To follow changes to them, read them again on a schedule.
Limits
- The catalogue lists the events of the API release the spec was published for. Releases that add events list them in the API changelog.
- The fields every event carries are on the overview.