| 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 users. Webhook Requests Definitions are initially configured to provide all the details related to the Webhook Request. The Webhook Request definitions are then added on workflows and then triggered accordingly.
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 |
|
|
Navigating to Webhook Requests
| Info |
|---|
FOUNDATION > WORKFLOWS > SET UP AND MANAGE Webhook RequestS > MANAGE Webhook RequestS |
|
| ||
| Resend |
| Not Applicable |
|
|---|
| Anchor | ||||
|---|---|---|---|---|
|
| Name | Description | |||
|---|---|---|---|---|
Number | The number of the Webhook Request. | |||
| Main Information | ||||
Life Cycle State | The life cycle Life Cycle State of the Webhook Request, which can be one of the followingis either:
| |||
TypeEntity | The type of the Webhook Request
| Entity | The Entity Number of the actual entry and the name of the entity Entity that was communicated through the Webhook, which can be:
| Entity ID
|
URL | The ID of the entity URL that was communicated through used by the Webhook Request | |||
Subject | The subject of the Webhook Request. This information is applicable only if the Webhook Request type is email | |||
Content | The content of the Webhook Request | |||
Recipient | The recipient of the Webhook Request | |||
Recipient Email Address | The recipient's email address, if the Webhook Request type is email. This information is applicable only if the Webhook Request type is email | |||
Recipient Phone Number | The recipient's phone number, if the Webhook Request type is SMS. This information is applicable only if the Webhook Request type is SMS | |||
Webhook Request Definition | The Webhook Request to send the information. | |||
Secret Key | The secret key that was used for authentication by the third party system. | |||
Fields Set | The set of fields used by the Webhook to send the information. | |||
Request | The full request that was sent by the Webhook, using the URL and Fields Set. | |||
Response | The response that was received by the third party system | |||
Webhook Definition | The Webhook definition that was used to send the Webhook Requestthe Webhook. | |||
Workflow Rule | The workflow rule Workflow Rule that triggered the Webhook Requestthe Webhook. | |||
Error Code | The code of the error that occurred while sending the Webhook Requestthe Webhook. This is applicable only for rejected Webhook Requestsapplies to rejected Webhooks only. | |||
Error Description | The description of the error that occurred while sending the Webhook Requestthe Webhook. This is applicable only for rejected Webhook Requestsapplies to rejected Webhooks only. | |||
| Log Information | Includes the standard log information | |||
Webhook Request Validations & Restrictions
| Action | Validations |
|---|---|
| DELETE |
|
Creating a Webhook Requests
Webhook Requests are automatically created
Viewing an WebhookLog 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
- Click on the Webhook Request you would like to view
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 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
ACTIONS > RESEND.
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Related Areas
|
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Popular LabelsPopular Labels | | |||||||
| spaceKey | V4Manual | style | heatmap
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|