| Tip |
|---|
Available from CRM.COM R9.0.0 |
GET webhook_requests/show
This method returns information related with a webhook request. A single webhook request is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(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:
...
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
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"response": "4A63ECC0D78946F8BF23D73681D6DA66",
"entity": "ACTIVITIES",
"error_code": "LazyInitializationException",
"error_description": "org.hibernate.LazyInitializationException: could not initialize proxy - no Session
at org.hibernate.proxy.AbstractLazyInitializer.initialize(AbstractLazyInitializer.java:167)
at org.hibernate.proxy.AbstractLazyInitializer.getImplementation(AbstractLazyInitializer.java:215)
at org.hibernate.proxy.pojo.javassist.JavassistLazyInitializer.invoke(JavassistLazyInitializer.java:191)
at com.crm.dataobject.securitymanagement.CRMDOSecretKey_$$_javassist_111.getKey(CRMDOSecretKey_$$_javassist_111.java)
at com.cr",
"number": "7",
"url": "http://127.0.0.1:9080/crmapi/rest/v2/activities/create",
"request": "4A63ECC0D78946F8BF23D73681D6DA66",
"log_information":
{
"updated_date": "2015-11-02T16:03:41",
"created_date": "2015-11-02T16:03:33",
"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": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
"name": "Installation Team 4",
"group_name": "Paphos",
"description": null,
"alternative_code": "IT4"
},
"created_by_user":
{
"person_name": "m_ioannou",
"username": "m_ioannou",
"id": "C5D6D95C71C4484F9168A5444FC928EF",
"email": "m_ioannou@crm.com"
},
"updated_by_user":
{
"person_name": "m_ioannou",
"username": "m_ioannou",
"id": "C5D6D95C71C4484F9168A5444FC928EF",
"email": "m_ioannou@crm.com"
}
},
"life_cycle_state": "REJECTED",
"entity_id": "4A63ECC0D78946F8BF23D73681D6DA66",
"id": "2429282E27054ABFB4A8F4F20593D241",
"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"
}
}
} |
|
GET webhook_requests/list
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)
...
workflow_rule_identifier
(semi-optional)
...
entity
(semi-optional)
...
The name of the entity related with the webhook requests that should be returned as a result. The supported entities are the following:
- ACTIVITIES
- SERVICEREQUESTS
- JOBS
- SUBSCRIPTIONS
...
entity_id
(semi-optional)
...
url
(optional)
...
life_cycle_state
(optional)
...
created_date
(optional)
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
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
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
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| {
"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"
}
]
} |
|
POST webhook_requests/resend
This method is used to re-send rejected webhook requests. This method is applicable only on rejected webhook requests. A single webhook request can be re-send through this method
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Webhook Request Identifier
The identifier of the webhook request that should be send again. The allowed webhook request Identifier fields are the following:
...
Note that only rejected webhook requests can be specified in this method.
...
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
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| {
"token":"7A5D6BFA7366434EB60EC189D6474836",
"webhook_request_identifier":{"number":"14"}
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"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:28:40",
"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"
}
}
} |
|
POST webhook_requests/delete
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
...
(mandatory)
...
Webhook Request Identifier
The identifier of the webhook request that should be deleted. The allowed webhook request Identifier fields are the following:
...
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
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| {
"token":"CAF6D5BF579D4883856B10C3BA19E1CB",
"webhook_request_identifier":{"number":"14"}
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"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"
}
}
} |
|
Webhook Request Data Structure Description
Activities
...
...
Jobs
...
...
Service Requests
...
...
Subscriptions
...
...
...
| Panel |
|---|
|
| Child pages (Children Display) |
|---|
|
|