WebhookEvents.batch_create_or_update

Create or update an batch of WebhookEvents

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of WebhookEvents on change. 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.

rollback-method

integer <int32>

optional

Specify rollback method for WebhookEvents. 0 - rollback all, 1 - rollback only failed records.

Body Params application / json

array of:

event

enum<string>

optional

Field whose values are strictly defined with an enumeration of values.

Allowed values:

*Account.*Account.CreateAccount.DeleteAccount.DocumentLinkedAccount.OwnerChangedAccount.UpdateActivityRelation.*ActivityRelation.CreateActivityRelation.DeleteActivityRelation.UpdateAppointment.*Appointment.CommentAppointment.CreateAppointment.DeleteAppointment.DocumentLinkedAppointment.OwnerChangedAppointment.UpdateContact.*Contact.CreateContact.DeleteContact.DocumentLinkedContact.OwnerChangedContact.UpdateContactAccountRelation.*ContactAccountRelation.CreateContactAccountRelation.DeleteContactAccountRelation.UpdateCurrency.*Currency.CreateCurrency.DeleteCurrency.UpdateCurrencyExchangeRate.*CurrencyExchangeRate.CreateCurrencyExchangeRate.DeleteCurrencyExchangeRate.UpdateCurrencyExchangeRatesList.*CurrencyExchangeRatesList.CreateCurrencyExchangeRatesList.DeleteCurrencyExchangeRatesList.UpdateCustomEntity.*CustomEntity.CreateCustomEntity.DeleteCustomEntity.DocumentLinkedCustomEntity.OwnerChangedCustomEntity.UpdateEmail.*Email.CreateEmail.DeleteEmail.DocumentLinkedEmail.UpdateLead.*Lead.BackToLeadLead.CreateLead.DeleteLead.DocumentLinkedLead.LostLead.OwnerChangedLead.UpdateLeadOpptyAccountRelation.*LeadOpptyAccountRelation.CreateLeadOpptyAccountRelation.DeleteLeadOpptyAccountRelation.UpdateLeadOpptyContactRelation.*LeadOpptyContactRelation.CreateLeadOpptyContactRelation.DeleteLeadOpptyContactRelation.UpdateMemo.*Memo.CommentMemo.CreateMemo.DeleteMemo.DocumentLinkedMemo.UpdateMessage.*Message.CreateMessage.DeleteMessage.DocumentLinkedMessage.UpdateNote.*Note.CreateNote.DeleteNote.UpdateOpportunity.*Opportunity.CreateOpportunity.DeleteOpportunity.DocumentLinkedOpportunity.LostOpportunity.MoveOpportunity.OwnerChangedOpportunity.QualifyOpportunity.UpdateOpportunity.WonOpptyProductRelation.*OpptyProductRelation.CreateOpptyProductRelation.DeleteOpptyProductRelation.UpdateProduct.*Product.CreateProduct.DeleteProduct.UpdateProductPriceList.*ProductPriceList.CreateProductPriceList.DeleteProductPriceList.UpdateProductPriceListPrice.*ProductPriceListPrice.CreateProductPriceListPrice.DeleteProductPriceListPrice.UpdateProject.*Project.CreateProject.DeleteProject.DocumentLinkedProject.OwnerChangedProject.UpdateQuote.*Quote.CreateQuote.DeleteQuote.DocumentLinkedQuote.LostQuote.MoveQuote.OwnerChangedQuote.UpdateQuote.WonQuoteAccountRelation.*QuoteAccountRelation.CreateQuoteAccountRelation.DeleteQuoteAccountRelation.UpdateQuoteContactRelation.*QuoteContactRelation.CreateQuoteContactRelation.DeleteQuoteContactRelation.UpdateTask.*Task.CommentTask.CreateTask.DeleteTask.DocumentLinkedTask.OwnerChangedTask.Update

Example:

webhook_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

string <uuid>

optional

ID of object to update.

Example

[
    {
        "event": "*",
        "webhook_id": "01234567-abcd-dcba-ffff-000000000000",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated WebhookEvents

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array [oneOf]

optional

string <uuid>

optional

And ID of created / updated entity.

object (Error)

optional

Example

{
    "success": true,
    "data": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

🔴500Server Error