Webhooks.list

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted Webhooks are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

filter

object

optional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

filter-op

object

optional

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Responses

🟢200OK

application/json

list of Webhooks

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (Webhook) {14}]

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

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

required

Webhook URL.

Example:

string

events

array[string]

required

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

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

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": [
                "*"
            ]
        }
    ],
    "page_info": {
        "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
        "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
        "has_previous_page": true,
        "has_next_page": true
    }
}

🔴500Server Error

Request

Request samples

Responses