ENUM
EventEnum
Webhook event a webhook subscribes to, named
link GraphQL Schema definition
- enum EventEnum {
- # Subscribes to every event of every entity in this list.
- # Subscribes to every lead event: LeadCreate, LeadUpdate, LeadDelete,
- # LeadBackToLead, LeadOwnerChanged, LeadDocumentLinked and LeadLost.
- # Fires when a lead is created.
- # Fires when a lead is updated.
- # Fires when a lead is deleted.
- # Fires when an opportunity is moved back to a lead; the event carries the
- # resulting lead.
- # Fires when the owner of a lead changes, including when it is created with an
- # owner other than the user who created it.
- # Fires when a document is linked to a lead; the event includes the document as
- # the related entity.
- # Fires when a lead is archived as lost.
- # Subscribes to every opportunity event: OpportunityCreate, OpportunityUpdate,
- # OpportunityDelete, OpportunityMove, OpportunityQualify, OpportunityOwnerChanged,
- # OpportunityDocumentLinked, OpportunityWon and OpportunityLost.
- # Fires when an opportunity is created.
- # Fires when an opportunity is updated.
- # Fires when an opportunity is deleted.
- # Fires when an opportunity moves to a different sales step; winning an
- # opportunity also raises this event.
- # Fires when a lead is qualified into an opportunity; the event carries the new
- # opportunity.
- # Fires when the owner of an opportunity changes, including when it is created
- # with an owner other than the user who created it.
- # Fires when a document is linked to an opportunity; the event includes the
- # document as the related entity.
- # Fires when an opportunity is created in or moved to the won step of its
- # pipeline.
- # Fires when an opportunity is archived as lost without reaching the won step.
- # Subscribes to every contact event: ContactCreate, ContactUpdate, ContactDelete,
- # ContactOwnerChanged and ContactDocumentLinked.
- # Fires when a contact is created.
- # Fires when a contact is updated.
- # Fires when a contact is deleted.
- # Fires when the owner of a contact changes, including when it is created with an
- # owner other than the user who created it.
- # Fires when a document is linked to a contact; the event includes the document as
- # the related entity.
- # Subscribes to every account event: AccountCreate, AccountUpdate, AccountDelete,
- # AccountOwnerChanged and AccountDocumentLinked.
- # Fires when an account is created.
- # Fires when an account is updated.
- # Fires when an account is deleted.
- # Fires when the owner of an account changes, including when it is created with an
- # owner other than the user who created it.
- # Fires when a document is linked to an account; the event includes the document
- # as the related entity.
- # Subscribes to every task event: TaskCreate, TaskUpdate, TaskDelete,
- # TaskOwnerChanged, TaskDocumentLinked and TaskComment.
- # Fires when a task is created.
- # Fires when a task is updated.
- # Fires when a task is deleted.
- # Fires when the owner of a task changes, including when it is created with an
- # owner other than the user who created it.
- # Fires when a document is linked to a task; the event includes the document as
- # the related entity.
- # Fires when a comment is added to a task.
- # Subscribes to every appointment event: AppointmentCreate, AppointmentUpdate,
- # AppointmentDelete, AppointmentOwnerChanged, AppointmentDocumentLinked and
- # AppointmentComment.
- # Fires when an appointment is created.
- # Fires when an appointment is updated.
- # Fires when an appointment is deleted.
- # Fires when the owner of an appointment changes, including when it is created
- # with an owner other than the user who created it.
- # Fires when a document is linked to an appointment; the event includes the
- # document as the related entity.
- # Fires when a comment is added to an appointment.
- # Legacy subscription to all message events; memo and email changes are delivered
- # as Memo and Email events instead.
- # Legacy event that is no longer raised; use MemoCreate or EmailCreate instead.
- # Legacy event that is no longer raised; use MemoUpdate or EmailUpdate instead.
- # Legacy event that is no longer raised; use MemoDelete or EmailDelete instead.
- # Legacy event that is no longer raised; use MemoDocumentLinked or
- # EmailDocumentLinked instead.
- # Subscribes to every memo event: MemoCreate, MemoUpdate, MemoDelete,
- # MemoDocumentLinked and MemoComment.
- # Fires when a memo is created.
- # Fires when a memo is updated.
- # Fires when a memo is deleted.
- # Fires when a document is linked to a memo; the event includes the document as
- # the related entity.
- # Fires when a comment is added to a memo.
- # Subscribes to every email event: EmailCreate, EmailUpdate, EmailDelete and
- # EmailDocumentLinked.
- # Fires when an email is created.
- # Fires when an email is updated.
- # Fires when an email is deleted.
- # Fires when a document is linked to an email; the event includes the document as
- # the related entity.
- # Subscribes to every opportunity product line event: OpptyProductRelationCreate,
- # OpptyProductRelationUpdate and OpptyProductRelationDelete.
- # Fires when a product line of an opportunity is created.
- # Fires when a product line of an opportunity is updated.
- # Fires when a product line of an opportunity is deleted.
- # Subscribes to every project event: ProjectCreate, ProjectUpdate, ProjectDelete,
- # ProjectOwnerChanged and ProjectDocumentLinked.
- # Fires when a project is created.
- # Fires when a project is updated.
- # Fires when a project is deleted.
- # Fires when the owner of a project changes, including when it is created with an
- # owner other than the user who created it.
- # Fires when a document is linked to a project; the event includes the document as
- # the related entity.
- # Subscribes to every quote event: QuoteCreate, QuoteUpdate, QuoteDelete,
- # QuoteOwnerChanged, QuoteDocumentLinked, QuoteMove, QuoteWon and QuoteLost.
- # Fires when a quote is created.
- # Fires when a quote is updated.
- # Fires when a quote is deleted.
- # Fires when the owner of a quote changes, including when it is created with an
- # owner other than the user who created it.
- # Fires when a document is linked to a quote; the event includes the document as
- # the related entity.
- # Fires when a quote moves to a different step of its quote process; winning a
- # quote also raises this event.
- # Fires when a quote is created in or moved to the won (accepted) step of its
- # quote process.
- # Fires when a quote is archived as lost without reaching the won step.
- # Subscribes to every custom entity event: CustomEntityCreate, CustomEntityUpdate,
- # CustomEntityDelete, CustomEntityOwnerChanged and CustomEntityDocumentLinked.
- # Fires when a custom entity record is created.
- # Fires when a custom entity record is updated.
- # Fires when a custom entity record is deleted.
- # Fires when the owner of a custom entity record changes, including when it is
- # created with an owner other than the user who created it.
- # Fires when a document is linked to a custom entity record; the event includes
- # the document as the related entity.
- # Subscribes to every contact-account link event: ContactAccountRelationCreate,
- # ContactAccountRelationUpdate and ContactAccountRelationDelete.
- # Fires when a contact is linked to an account.
- # Fires when the link between a contact and an account is updated.
- # Fires when a contact is unlinked from an account.
- # Subscribes to every lead/opportunity account link event:
- # LeadOpptyAccountRelationCreate, LeadOpptyAccountRelationUpdate and
- # LeadOpptyAccountRelationDelete.
- # Fires when an account is linked to a lead or opportunity.
- # Fires when the link between an account and a lead or opportunity is updated.
- # Fires when an account is unlinked from a lead or opportunity.
- # Subscribes to every lead/opportunity contact link event:
- # LeadOpptyContactRelationCreate, LeadOpptyContactRelationUpdate and
- # LeadOpptyContactRelationDelete.
- # Fires when a contact is linked to a lead or opportunity.
- # Fires when the link between a contact and a lead or opportunity is updated.
- # Fires when a contact is unlinked from a lead or opportunity.
- # Subscribes to every activity link event: ActivityRelationCreate,
- # ActivityRelationUpdate and ActivityRelationDelete.
- # Fires when a task or appointment is linked to a record.
- # Fires when the link between a task or appointment and a record is updated.
- # Fires when a task or appointment is unlinked from a record.
- # Subscribes to every quote-account link event: QuoteAccountRelationCreate,
- # QuoteAccountRelationUpdate and QuoteAccountRelationDelete.
- # Fires when an account is linked to a quote.
- # Fires when the link between an account and a quote is updated.
- # Fires when an account is unlinked from a quote.
- # Subscribes to every quote-contact link event: QuoteContactRelationCreate,
- # QuoteContactRelationUpdate and QuoteContactRelationDelete.
- # Fires when a contact is linked to a quote.
- # Fires when the link between a contact and a quote is updated.
- # Fires when a contact is unlinked from a quote.
- # Subscribes to every product event: ProductCreate, ProductUpdate and
- # ProductDelete.
- # Fires when a product is created.
- # Fires when a product is updated.
- # Fires when a product is deleted.
- # Subscribes to every note event: NoteCreate, NoteUpdate and NoteDelete.
- # Fires when a note is created.
- # Fires when a note is updated.
- # Fires when a note is deleted.
- # Subscribes to every currency event: CurrencyCreate, CurrencyUpdate and
- # CurrencyDelete.
- # Fires when a currency is created.
- # Fires when a currency is updated.
- # Fires when a currency is deleted.
- # Subscribes to every exchange rate event: CurrencyExchangeRateCreate,
- # CurrencyExchangeRateUpdate and CurrencyExchangeRateDelete.
- # Fires when an exchange rate is created.
- # Fires when an exchange rate is updated.
- # Fires when an exchange rate is deleted.
- # Subscribes to every exchange rate list event: CurrencyExchangeRatesListCreate,
- # CurrencyExchangeRatesListUpdate and CurrencyExchangeRatesListDelete.
- # Fires when an exchange rate list is created.
- # Fires when an exchange rate list is updated.
- # Fires when an exchange rate list is deleted.
- # Subscribes to every price list event: ProductPriceListCreate,
- # ProductPriceListUpdate and ProductPriceListDelete.
- # Fires when a price list is created.
- # Fires when a price list is updated.
- # Fires when a price list is deleted.
- # Subscribes to every price list price event: ProductPriceListPriceCreate,
- # ProductPriceListPriceUpdate and ProductPriceListPriceDelete.
- # Fires when a product price in a price list is created.
- # Fires when a product price in a price list is updated.
- # Fires when a product price in a price list is deleted.
- }
link Require by
- CreateOrUpdateWebhookEventInputField values of a WebhookEvent record to create, or to update when its id is set.
- CreateOrUpdateWebhookInputField values of a Webhook record to create, or to update when its id is set.
- CreateWebhookEventInputField values of a new WebhookEvent record.
- CreateWebhookInputField values of a new Webhook record.
- UpdateWebhookEventInputId of a WebhookEvent record and the field values to change.
- UpdateWebhookInputId of a Webhook record and the field values to change.
- WebhookEntityRegistered webhook urls will be called when subscribed events occur with access level corresponding to the Webhook owner. Recipient has to receive the webhook in 10 seconds and respond with HTTP 200 (2XX) status. On failed delivery it will be retried up to 10 times within 24 hours. If the receiving side will respond with HTTP 410 status, the webhook will be disabled. Webhook is also disabled when we receive HTTP timeout on 10th retry and there was no successful delivery in last 5 days.
- WebhookEventEntityEvent a webhook subscribes to; the webhook is called whenever the event occurs.