GET webhook_requests/list

Available from CRM.COM R9.0.0

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

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

webhook_definition_identifier

(semi-optional)

Webhook Definition Identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the webhook definition

name

(semi-optional)

String

The name of the webhook definition

alternative_code

(semi-optional)

String

The alternative code of the webhook definition

workflow_rule_identifier

(semi-optional)

Workflow Rule Identifier

The 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:

Name

Type

Description

id

(semi-optional)

String

The ID of the workflow rule

name

(semi-optional)

String

The name of the workflow rule

alternative_code

(semi-optional)

String

The alternative code of the workflow rule

entity

(semi-optional)

String

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

ACCOUNTSRECEIVABLE
ACTIVITIES
CONTACTINFORMATION
CREDITNOTES
INVOICES
INVOICECANCELLATIONS
JOBS
LEADS
PAYMENTS
PAYMENTCANCELLATIONS
REFUNDS
REWARDOFFERS
SERVICEREQUESTS
SUBSCRIPTIONS
WALLETS
WALLETTRANSACTIONS
WRITEOFFS

LEADS entity is available from CRM.COM R14.0.0
ACCOUNTSRECEIVABLE, CONTACTINFORMATION, CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0

entity_id

(semi-optional)

String

The ID of the entity related to the webhook requests that should be returned as a result

url

(optional)

String

The URL related to the webhook requests that should be returned as a result

life_cycle_state

(optional)

String

The 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

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

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

Restrictions

It is mandatory to specify at least one of the semi-optional parameters. Multiple of those parameters are allowed to be specified.

Response Data

Name	Type	Description
id	String	The ID of the retrieved webhook request
number	String	The number of the retrieved webhook request
life_cycle_state	String	The life cycle state of the retrieved webhook request which can be SUCCESSFUL or REJECTED
entity	String	The name of the entity that was communicated through the webhook request. The supported entities are the following: ACCOUNTSRECEIVABLE ACTIVITIES CONTACTINFORMATION CREDITNOTES INVOICES INVOICECANCELLATIONS JOBS LEADS PAYMENTS PAYMENTCANCELLATIONS REFUNDS REWARDOFFERS SERVICEREQUESTS SUBSCRIPTIONS WALLETS WALLETTRANSACTIONS WRITEOFFS LEADS entity is available from CRM.COM R14.0.0 ACCOUNTSRECEIVABLE, CONTACTINFORMATION, CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0
entity_id	String	The ID of the entity that was communicated through the webhook request
url	String	The URL that was used by the webhook to send the information
authentication_code	String	The code that will be used for authentication purposes. The code is an HMAC (Hash Message Authentication Code) generated using the data JSON object and the secret key selected on the related definition
fields_set	String	The fields set that was used by the webhook to send the information
request	JSON Object	The request that was sent by the webhook
response	JSON Object	The response that was received by the webhook
error_code	String	The code of the error that occurred while sending the webhook request. This is applicable only for rejected webhook request
error_description	String	The description of the error that occurred while sending the webhook request. This is applicable only for rejected webhook request
webhook_definition	Webhook Definition Object	The webhook definition that was used to send the webhook request
workflow_rule	Workflow Rule Object	The workflow rule that triggered the webhook request
log_information	Log Information Object	The log information of the retrieved webhook request

Referred Objects Response Data

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

webhook_definition object response data

Name	Type	Description
id	String	The ID of the retrieved webhook definition
alternative_code	String	The alternative code of the retrieved webhook definition
name	String	The name of the retrieved webhook definition
life_cycle_state	String	The life cycle state of the retrieved webhook definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE

workflow_rule object response data

Name	Type	Description
id	String	The ID of the retrieved workflow rule
alternative_code	String	The alternative code of the retrieved workflow rule
name	String	The name of the retrieved workflow rule
life_cycle_state	String	The life cycle state of the retrieved workflow rule. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "error_code": "Error code 44",
            "life_cycle_state": "REJECTED",
            "number": "3",
            "id": "76DE190EFBE1FF070F9AD07911F18A6E"
        },
        {
            "life_cycle_state": "SUCCESSFUL",
            "number": "4",
            "id": "D182290BC47C4602B2FEAB5822E70663"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "2",
            "id": "24C2B2231327471E8A206015BA81BB3E"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "3",
            "id": "03E7B20295FE477EB9851C182455E0F2"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "4",
            "id": "99349C766CAA4696B2D47B32B359DFC1"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "5",
            "id": "05A511C6832F4F59A4A764378E3BA360"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "6",
            "id": "60E3CCE8EA444260BCF94DC7FDCCC72E"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "7",
            "id": "2429282E27054ABFB4A8F4F20593D241"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "8",
            "id": "9CE8F5BE752042CEB815E3BB69BC78BC"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "9",
            "id": "D45293C837D84E5ABB3F870CAFC3D528"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "11",
            "id": "88A1482105A54DE885A72D2D3D0FBB15"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "12",
            "id": "D30BFF87AF524479B2955E6710E463CF"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "13",
            "id": "271A5C58AAD7495BA01572AEF32C94F0"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "14",
            "id": "5376CA25E81D4ECE8F87B9E3346857B9"
        },
        {
            "error_code": "LazyInitializationException",
            "life_cycle_state": "REJECTED",
            "number": "15",
            "id": "D3B212F76E5342CC97946BC5951144AD"
        }
    ]
}