v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Webhook

WebhookEvents.update

Modifies WebhookEvent or WebhookEvents with given id(s)

patch/entities/WebhookEvents/{id}

Path parameters

idstring uuid required

ID of WebhookEvent to update

Query parameters

validation-levelinteger

Specify validation level of WebhookEvent on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

event'*' | 'Account.*' | 'Account.Create' | 'Account.Delete' | 'Account.DocumentLinked' | 'Account.OwnerChanged' | 'Account.Update' | 'ActivityRelation.*' | 'ActivityRelation.Create' | 'ActivityRelation.Delete' | 'ActivityRelation.Update' | 'Appointment.*' | 'Appointment.Comment' | 'Appointment.Create' | 'Appointment.Delete' | 'Appointment.DocumentLinked' | 'Appointment.OwnerChanged' | 'Appointment.Update' | 'Contact.*' | 'Contact.Create' | 'Contact.Delete' | 'Contact.DocumentLinked' | 'Contact.OwnerChanged' | 'Contact.Update' | 'ContactAccountRelation.*' | 'ContactAccountRelation.Create' | 'ContactAccountRelation.Delete' | 'ContactAccountRelation.Update' | 'Currency.*' | 'Currency.Create' | 'Currency.Delete' | 'Currency.Update' | 'CurrencyExchangeRate.*' | 'CurrencyExchangeRate.Create' | 'CurrencyExchangeRate.Delete' | 'CurrencyExchangeRate.Update' | 'CurrencyExchangeRatesList.*' | 'CurrencyExchangeRatesList.Create' | 'CurrencyExchangeRatesList.Delete' | 'CurrencyExchangeRatesList.Update' | 'CustomEntity.*' | 'CustomEntity.Create' | 'CustomEntity.Delete' | 'CustomEntity.DocumentLinked' | 'CustomEntity.OwnerChanged' | 'CustomEntity.Update' | 'Email.*' | 'Email.Create' | 'Email.Delete' | 'Email.DocumentLinked' | 'Email.Update' | 'Lead.*' | 'Lead.BackToLead' | 'Lead.Create' | 'Lead.Delete' | 'Lead.DocumentLinked' | 'Lead.Lost' | 'Lead.OwnerChanged' | 'Lead.Update' | 'LeadOpptyAccountRelation.*' | 'LeadOpptyAccountRelation.Create' | 'LeadOpptyAccountRelation.Delete' | 'LeadOpptyAccountRelation.Update' | 'LeadOpptyContactRelation.*' | 'LeadOpptyContactRelation.Create' | 'LeadOpptyContactRelation.Delete' | 'LeadOpptyContactRelation.Update' | 'Memo.*' | 'Memo.Comment' | 'Memo.Create' | 'Memo.Delete' | 'Memo.DocumentLinked' | 'Memo.Update' | 'Message.*' | 'Message.Create' | 'Message.Delete' | 'Message.DocumentLinked' | 'Message.Update' | 'Note.*' | 'Note.Create' | 'Note.Delete' | 'Note.Update' | 'Opportunity.*' | 'Opportunity.Create' | 'Opportunity.Delete' | 'Opportunity.DocumentLinked' | 'Opportunity.Lost' | 'Opportunity.Move' | 'Opportunity.OwnerChanged' | 'Opportunity.Qualify' | 'Opportunity.Update' | 'Opportunity.Won' | 'OpptyProductRelation.*' | 'OpptyProductRelation.Create' | 'OpptyProductRelation.Delete' | 'OpptyProductRelation.Update' | 'Product.*' | 'Product.Create' | 'Product.Delete' | 'Product.Update' | 'ProductPriceList.*' | 'ProductPriceList.Create' | 'ProductPriceList.Delete' | 'ProductPriceList.Update' | 'ProductPriceListPrice.*' | 'ProductPriceListPrice.Create' | 'ProductPriceListPrice.Delete' | 'ProductPriceListPrice.Update' | 'Project.*' | 'Project.Create' | 'Project.Delete' | 'Project.DocumentLinked' | 'Project.OwnerChanged' | 'Project.Update' | 'Quote.*' | 'Quote.Create' | 'Quote.Delete' | 'Quote.DocumentLinked' | 'Quote.Lost' | 'Quote.Move' | 'Quote.OwnerChanged' | 'Quote.Update' | 'Quote.Won' | 'QuoteAccountRelation.*' | 'QuoteAccountRelation.Create' | 'QuoteAccountRelation.Delete' | 'QuoteAccountRelation.Update' | 'QuoteContactRelation.*' | 'QuoteContactRelation.Create' | 'QuoteContactRelation.Delete' | 'QuoteContactRelation.Update' | 'Task.*' | 'Task.Comment' | 'Task.Create' | 'Task.Delete' | 'Task.DocumentLinked' | 'Task.OwnerChanged' | 'Task.Update'

Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space.

webhook_idstring uuid

Id of the parent webhook.

Example request

{
  "event": "*",
  "webhook_id": "01234567-abcd-dcba-ffff-000000000000"
}

Response

Modification confirmation. Returns resulting WebhookEvent

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "event": "*",
    "webhook_id": "01234567-abcd-dcba-ffff-000000000000"
  }
}