Versions Compared

Old Version 1

changes.mady.by.user George Rossides (Unlicensed)

Saved on

compared with

New Version 2

changes.mady.by.user George Rossides (Unlicensed)

Saved on

Key

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

Available from CRM.COM R9.0.0


Table of Contents
maxLevel2

...

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 returned as a result. The allowed webhook request Identifier fields are the following:

Include Page
V4:alertwebhook_request_identifier
V4:alertwebhook_request_identifier

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

...

Response Data

Include Page
V4:alertwebhook_request_complete
V4:alertwebhook_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
 

...

webhook_definition_identifier

(semi-optional)

Name

Type

Description

token

String

The token retrieved from the login method

recipient_identifier
(semi-optional)		Recipient IdentifierThe identifier of the recipient related with the webhook requests that should be returned as a result. The allowed recipient identifier fields are the following:

Include Page
V4:user_identifierV4:user_identifierWebhook Definition IdentifierThe identifier of the webhook definition related with the webhook requests that should be returned as a result. The allowed webhook request definition identifier fields are the following:

Include Page
V4:alertwebhook_definition_identifier
V4:alertwebhook_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:

  • ACTIVITIES

entity_id

(semi-optional)

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

recipient_email_addressurl

(optional)

StringThe email address of the recipient related with the webhook requests that should be returned as a result

recipient_phone_number

(optional)

StringThe phone number of the recipient 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 EFFECTIVE SUCCESSFUL or NOT_EFFECTIVEREJECTED

created_date

(optional)

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

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

...

Response Data

Include Page
V4:alertwebhook_request_complete
V4:alertwebhook_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
 

...

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 send again. The allowed webhook request Identifier fields are the following:

Include Page
V4:alertwebhook_request_identifier
V4:alertwebhook_request_identifier

Note that only rejected webhook requests can be specified in this method.

 

...

Response Data

Include Page
V4:alertwebhook_request_complete
V4:alertwebhook_request_complete

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejs
linenumberstrue
 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

...

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:

Include Page
V4:alertwebhook_request_identifier
V4:alertwebhook_request_identifier

 

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:alertwebhook_request_complete
V4:alertwebhook_request_complete

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejs
linenumberstrue
 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue