| Excerpt | ||
|---|---|---|
| ||
Find out how to create a new Learn to work with Webhook Requests - status |
| Panel | |||
|---|---|---|---|
| Red
| ||
| title | Available from CRM.COM R9.0.0 |
| 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 |
Table of Contents
|
Navigating to Webhook Requests
| Info |
|---|
FOUNDATION > WORKFLOWS > SET UP AND MANAGE WEBHOOK > MANAGE WEBHOOK REQUESTS |
Using Webhook Requests
- Navigate to Webhook Requests and explore existing entries via the Summary page.
- Click on the link (Name or Number) of the entry of your interest to enter the Data Entry page and see more detail.
- Use the Actions Menu to DELETE an existing Request.
- Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Webhook Requests.
- Click on ACTIONS to discover other possibilities available for Webhook Requests.
Check the Validations & Restrictions Table for a list of available Actions when working with Webhook Requests including each Action's related restrictions, additional information and a description of its system process. View the Attributes Table below for a comprehensive description of the Webhook Requests fields.
| Anchor | ||||
|---|---|---|---|---|
|
| Action | Restrictions | Additional Information | System Processing |
|---|---|---|---|
| Create |
|
|
|
| Edit |
|
|
|
| Delete |
|
|
|
| Resend |
| Not Applicable |
|
| Anchor | ||||
|---|---|---|---|---|
|
| Name | Description | ||
|---|---|---|---|
Number | The number of the webhook requestWebhook Request. | ||
| Main Information | |||
Life Cycle State | The life cycle Life Cycle State of the webhook requestWebhook Request, which can be one of the followingis either:
| ||
Entity | The Entity Number of the actual entry and the name of the entity Entity that was communicated through the webhook | Entity ID | The ID of the entity that was communicated through the webhookthe Webhook, which can be:
|
URL | The URL that was used by the webhook Webhook to send the information. | ||
Secret Key | The secret key that was used for authentication purposes by the third party system. | ||
Fields Set | The set of fields set that was used by the webhook Webhook to send the information. | ||
Request | The full request that was send sent by the webhookthe Webhook, using the URL and Fields Set. | ||
Response | The response that was received by the webhookthird party system | ||
Webhook Definition | The webhook Webhook definition that was used to send the webhookthe Webhook. | ||
Workflow Rule | The workflow rule Workflow Rule that triggered the webhookthe Webhook. | ||
Error Code | The code of the error that occurred while sending the webhook the Webhook. This is applicable only for rejected webhookapplies to rejected Webhooks only. | ||
Error Description | The description of the error that occurred while sending the webhook the Webhook. This is applicable only for rejected webhookapplies to rejected Webhooks only. | ||
| 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
Log Details | The standard set of Log Details information available in all entities. |
|---|
Additional Actions for Webhooks
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, Search for the rejected request to resend and click on its Number to go to the Data Entry page.
- From the Action Actions Menu click on DeleteClick 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
ACTIONS > RESEND.
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Related Areas
|
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Popular LabelsPopular Labels | | |||||||
| spaceKey | V4Manual | style | heatmap
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|