| Excerpt | ||||||
|---|---|---|---|---|---|---|
| ||||||
Find out how to create a new Webhook Requests -
|
| Status | ||||
|---|---|---|---|---|
|
What does this section cover?
| Table of Contents | ||
|---|---|---|
|
What are Webhook Requests
Webhook requests are used to log the actual information that was send to third party systems through a webhook. Both successful and rejected requests are shown
- Webhook Requests are triggered by the system based on the Webhook Definitions & Workflow Rules
- Webhook Requests cannot be modified
- Webhook Requests can be deleted via the data entry page or via the summary page (Multiple Webhook Requests can be deleted via the Summary page)
Navigating to Webhook Requests
| Info |
|---|
FOUNDATION > WORKFLOWS > SET UP AND MANAGE WEBHOOK REQUESTS > MANAGE WEBHOOK REQUESTS |
Explaining Webhook Requests Fields
| Name | Description |
|---|---|
Number | The number of the webhook request |
Life Cycle State | The life cycle of the webhook request, which can be one of the following:
|
Entity | The name of the entity that was communicated through the webhook |
Entity ID | The ID of the entity that was communicated through the webhook |
URL | The URL that was used by the webhook to send the information |
Secret Key | The secret key that was used for authentication purposes by the third party system |
Fields Set | The fields set that was used by the webhook to send the information |
Request | The request that was send by the webhook |
Response | The response that was received by the webhook |
Webhook Definition | The webhook definition that was used to send the webhook |
Workflow Rule | The workflow rule that triggered the webhook |
Error Code | The code of the error that occurred while sending the webhook . This is applicable only for rejected webhook |
Error Description | The description of the error that occurred while sending the webhook . This is applicable only for rejected webhook |
Log Information | Includes the standard log information |
Webhook Request Validations & Restrictions
| Action | Validations | Restrictions |
|---|---|---|
| DELETE |
| |
| RESEND |
|
|
Creating a Webhook Requests
Webhook Requests are automatically created through Workflow Rules
Viewing an Webhook Request
- Navigate to Webhook Requests page
- Search using the criteria available in the summary page
- Click on the Webhook Request you would like to view
- Successful Webhook Request
- Rejected Webhook Request
- Successful Webhook Request
Resending a Rejected Webhook Request
- Navigate to Webhook Requests page
- Search using the criteria available in the summary page for the rejected requests
- Click on the Webhook Request you would like to resend to go to the data entry page
- From the Actions Menu click on ACTIONS > RESEND
- Once submitted the system will
- Create a new webhook request
- If the new webhook request is send successfully then
- The rejected webhook request is deleted
- If the webhook definition logging method is set to "Log all Webhook Requests" then
- The webhook request is logged in the webhook requests entity as successful
- If the new webhook request is rejected then
- The rejected webhook request is updated with the latest error code, error description and update date / user information
Deleting an Webhook Request from Data Entry Page
- Navigate to Webhook Requests
- Search for the Webhook Request you would like to delete
- Click on the number/name of the record you would like to access, to go to the Data Entry page
- From the Action Menu click on Delete
- Click Yes on the Confirmation message box
Deleting Multiple Webhook Requests from Summary Page
- Navigate to Webhook Requests
- Search for Webhook Requests using the criteria
- Select the Webhook Requests you would like to delete by adding a check in the checkbox on the left hand side of the Webhook Requests
- From the Action Menu click on ACTIONS > DELETE
- Click on SAVE from the modal
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Related Areas
|
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Popular Labels
|