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 |