POST webhook_requests/delete

Available from CRM.COM R9.0.0

This method is used to delete successful or rejected webhook requests. A single webhook request can be deleted through this method

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

webhook_request_identifier

(mandatory)

Webhook Request Identifier

The identifier of the webhook request that should be deleted. The allowed webhook request Identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the webhook request

number

(semi-optional)

String

The number of the webhook request

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 one of the semi-optional parameters. Only one of those parameters is 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: POST

Request:

Body:

{
    "token":"CAF6D5BF579D4883856B10C3BA19E1CB",
    "webhook_request_identifier":{"number":"14"}
}

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "response": "1D7C94CAC7AB4BB39B85E91183872F11",
        "entity": "ACTIVITIES",
        "error_code": null,
        "error_description": null,
        "number": "14",
        "url": "http://127.0.0.1:9080/crmapi/rest/v2/activities/create",
        "request": "1D7C94CAC7AB4BB39B85E91183872F11",
        "log_information":
        {
            "updated_date": "2015-11-06T08:45:11",
            "created_date": "2015-11-05T17:44:31",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                "name": "Installation Team 4",
                "group_name": "Paphos",
                "description": null,
                "alternative_code": "IT4"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "m_michael_user",
                "username": "m_michael_user",
                "id": "970A84FDE9784FCF807597FEA26FA0F1",
                "email": "m_michael@crm.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "life_cycle_state": "REJECTED",
        "entity_id": "1D7C94CAC7AB4BB39B85E91183872F11",
        "id": "82F0B415260047218DECF32FEBDFBA01",
        "webhook_definition":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "53D29BC888854021A238DF9FEB7D6F76",
            "name": "Test",
            "alternative_code": "T"
        },
        "fields_set": null,
        "workflow_rule":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "A94ABA3BDF2745FA8AE8F5B71DD4CA8F",
            "name": "Activity Rule",
            "alternative_code": "AR"
        }
    }
}