Webhooks.update - PipelinerCRM

Request

Path Params

string <uuid>

required

ID of Webhook to update

Query Params

validation-level

integer <int32>

optional

Specify validation level of Webhook 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.

Body Params application/json

insecure_ssl

boolean

optional

If True, remote side ssl certificate will not be validated when delivering notifications.

Example:

false

options

object

optional

Params in REST API format (snake case), to modify the content of the WebHook.
You can set "entity" options of the main entity on which the event occurs.
E.g. Account for events like Account.Create, Account.Update, Account.Delete.
For events with a secondary related entity you can also options under key "related_entity".
E.g. for Account.LinkedDocument event, the "expand" option of CloudObject(Document)
can be set under "related_entity" key.
Filter follows REST API conventions:
http://pipeliner-api-doc.s3-website-eu-west-1.amazonaws.com/latest/rest/space/index.html
In addition, to REST params, you can conditionally trigger webhook
only when specified fields will change. You can use "on-field-change" param and provide
a list of api names on which this change will listen. The "on-field-change" option is available for Account,
Appointment, Task, Contact, Opportunity, Lead, Product Line Item, Project, Quote and Custom Entity.

Suppressing Webhooks
You can specify list of strings under "skip_keys" key in options.
Whenever you make an API request with header "Webhook-Skip-Key"
equal to any of the specified skip keys,
the Webhook will not be triggered. This can prevent a Webhook loop.

Example:
{
"entity": {
"Contact": {
"expand": [
"primary_account",
"primary_contact",
"task_relations.task"
],
"load-only": [
"id",
"primary_account",
"primary_contact.first_name",
"task_relations.task"
],
"filter": {
"email1": ["test@example.com", "test@example.net"],
"email2": "test@example.com"
},
"filter-op": {"email1": "eq"}, # optional, default operator is eq
"on-field-change": ["email1"]
},
"Account": {
"filter": {
"owner_id": ["9900cce6-bcd6-412a-bcd1-1904556c949a"]
}
}
},
"related_entity": {"expand": ["contact"], "load-only": ["id", "contact"]},
"skip_keys": ["gmail_sync", "custom_integration"],
"chunk_size": 100, // defines the size of the chunk, default is 100, max is 100.
"chunk_delay": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0.
"custom_entity_api_name": ["CE_Name1", "CE_Name2"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types.
}

signature

string <uuid>

optional

Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header.

Example:

01234567-abcd-dcba-ffff-000000000000

url

string

optional

Webhook URL.

Example:

string

events

array[string]

optional

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

{
    "insecure_ssl": false,
    "options": {},
    "signature": "01234567-abcd-dcba-ffff-000000000000",
    "url": "string",
    "events": [
        "*"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting Webhook

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Webhook)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

application

string <uri>

read-onlyoptional

Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties.

client

string <uri>

optional

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

application_id

string <uuid>

read-onlyoptional

Id of definer application of the Webhook.

Example:

01234567-abcd-dcba-ffff-000000000000

client_id

string <uuid>

optional

Id of definer client of the Webhook.

Example:

01234567-abcd-dcba-ffff-000000000000

insecure_ssl

boolean

required

If True, remote side ssl certificate will not be validated when delivering notifications.

Example:

false

options

object

optional

signature

string <uuid>

optional

Example:

01234567-abcd-dcba-ffff-000000000000

url

string

required

Webhook URL.

Example:

string

events

array[string]

required

Allowed values:

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "application": "http://example.com",
        "client": "http://example.com",
        "application_id": "01234567-abcd-dcba-ffff-000000000000",
        "client_id": "01234567-abcd-dcba-ffff-000000000000",
        "insecure_ssl": false,
        "options": {},
        "signature": "01234567-abcd-dcba-ffff-000000000000",
        "url": "string",
        "events": [
            "*"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error