Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

Webhooks.list

Returns all defined Webhooks

Input

type: object properties: parameters: type: object properties: include-deleted: type: boolean description: if enabled, deleted Webhooks are returned as well first: type: integer format: int32 description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 last: type: integer format: int32 description: >- 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: type: string description: Cursor until which to take entities to result set. after: type: string description: Cursor after which to start taking entities to result set. expand: type: string description: >- 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. order-by: type: string description: >- 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. filter: type: object description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. filter-op: type: object description: >- 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: type: string description: >- 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. title: Parameters

Output

type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: required: - is_delete_protected - id - insecure_ssl - url - events properties: is_delete_protected: type: boolean example: false description: >- 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. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Creation time. readOnly: true application: type: string format: uri description: >- 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. readOnly: true client: type: string format: uri description: >- 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: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of definer application of the Webhook. readOnly: true client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of definer client of the Webhook. insecure_ssl: type: boolean example: false description: >- If True, remote side ssl certificate will not be validated when delivering notifications. options: type: object description: >- 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. 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": ["[email protected]", "[email protected]"], "email2": "[email protected]" }, "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. } signature: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: >- 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. url: type: string example: string description: Webhook URL. events: type: array description: '' items: type: string example: '*' enum: - '*' - Account.* - Account.Create - Account.Delete - Account.DocumentLinked - Account.OwnerChanged - Account.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 - 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 - 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 - 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 - Task.* - Task.Comment - Task.Create - Task.Delete - Task.DocumentLinked - Task.OwnerChanged - Task.Update type: object page_info: type: object description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it).