Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R9.0.0

Excerpt

This method returns information related with webhook requests having specific attributes. Multiple webhook requests are returned by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

webhook_definition_identifier

(semi-optional)

Webhook Definition IdentifierThe identifier of the webhook definition related with the webhook requests that should be returned as a result. The allowed webhook definition identifier fields are the following:

Include Page
V4:webhook_definition_identifier
V4:webhook_definition_identifier

workflow_rule_identifier

(semi-optional)

Workflow Rule IdentifierThe identifier of the workflow rule that triggered the webhook requests that should be returned as a result. The allowed workflow rule identifier fields are the following:

Include Page
V4:workflow_rule_identifier
V4:workflow_rule_identifier

entity

(semi-optional)

String

The name of the entity related with the webhook requests that should be returned as a result. The supported entities are the following:

  • ACCOUNTSRECEIVABLE
  • ACTIVITIES
  • CONTACTINFORMATION
  • SERVICEREQUESTSFINANCIALTRANSACTIONS
  • JOBS
  • LEADS
  • REWARDOFFERS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
  • WALLETS
  • LEADSWALLETTRANSACTIONS
Tip

LEADS entity is available from CRM.COM R14.0.0

ACCOUNTSRECEIVABLE, CONTACTINFORMATION, REWARDOFFERS, FINANCIALTRANSACTIONS,WALLETS, WALLETTRANSACTIONS are available from CRM.COM R14.1.0

entity_id

(semi-optional)

StringThe ID of the entity related with the webhook requests that should be returned as a result

url

(optional)

StringThe URL related with the webhook requests that should be returned as a result

life_cycle_state

(optional)

StringThe life cycle state of the webhook requests that should be returned as a result. The supported options are SUCCESSFUL or REJECTED

created_date

(optional)

Date The created date of the webhook requests that should be returned as a result.

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.0.0

fields_set
(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...