You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
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 |
| 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: 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
|
| 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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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:
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) | Webhook Definition Identifier | The 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: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 with the webhook requests that should be returned as a result. The supported entities are the following: |
entity_id (semi-optional) | String | The ID of the entity related with the webhook requests that should be returned as a result |
url (optional) | String | The URL related with 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. |
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
|
| 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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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:
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 | |
| 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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the webhook request | number (semi-optional) | String | The number of the webhook request |
Note that only rejected webhook requests can be specified in this method. | |
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
|
| 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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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:
Response:
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 | |
| 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 |
| |
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
|
| 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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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:
Response: