Versions Compared

Old Version 5

changes.mady.by.user Persia Xenopoulou

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Back to Workflows Main Page

Excerpt
hiddentrue

Find out how to create a new Learn to work with Webhook Requests - status

Webhook Requests are triggered by the system based on the Webhook Definitions & Workflow RulescolourRed
Panel
name
blue
titleAvailable from CRM.COM R9.0.0

Status
colourRed
titleAvailable from CRM.COM R9.0.0

What does this section cover?

Table of Contents
minLevel2

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

Table of Contents

Table of Contents
minLevel2

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.  

Image Added

 

Anchor
validations
validations
Validations & Restrictions

ActionRestrictionsAdditional InformationSystem Processing
Create
  •  Not Applicable
  • Not Applicable
Edit
  • Webhook Requests cannot be modified
  •  Not Applicable
  • Not Applicable
Delete
  • Not Applicable
  • Multiple 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
  • simultaneously using the respective action available in the Summary Page.
  • Not Applicable
Resend
  • Can be applied only on a single rejected Webhook request at a time.
 Not Applicable
  • Creates a new Webhook Request.
  • If the new Webhook Request is sent 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 date / user information.

 

Anchor
attributes
attributes
Attributes

NameDescription

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:

  • Successful
  • Rejected

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:

  • Service Request
  • Activity
  • Subscription
  • Job

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 webhookWebhook, 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

Validations
ActionRestrictionsDELETE
  • No validations
 
RESEND

 

  • Can be applied only on a single rejected webhook request at each time.

Creating a Webhook Requests

Webhook Requests are automatically created through Workflow Rules 

Viewing an Webhook Request

  1. Navigate to Webhook Requests page
  2. Search using the criteria available in the summary page
  3. Click on the Webhook Request you would like to view 
    • Successful Webhook RequestSUCCESSFUL WEBHOOK REQUESTImage Removed
    • Rejected Webhook Request
      Rejected Webhook RequestImage Removed

Log Details

The standard set of Log Details information available in all entities.

 

Additional Actions for Webhooks

Resending a Rejected Webhook Request

  1. Navigate to Webhook Requests page
  2. Search using the criteria available in the summary page for the rejected requests
  3. Click on the Webhook Request you would like to resend to go to the data entry page
  4. From the Actions Menu click on ACTIONS > RESEND
    RESEND REJECTED REQUESTImage Removed
  5. Once submitted the system will
    1. Create a new webhook request
    2. If the new webhook request is send successfully then
      • The rejected webhook request is deleted
      1. 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
    3. 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

  1. Navigate to Webhook Requests
  2. Search for the Webhook Request you would like to delete
    3. Click on the number/name of the record you would like to access,
  3. .
  4. Search for the rejected request to resend and click on its Number to go to the Data Entry page.
  5. From the Action Actions Menu click on Delete
    ACTIO DELETE FROM DATA ENTRY PAGEImage Removed    Click Yes on the Confirmation message box

Deleting Multiple Webhook Requests from Summary Page

  1. Navigate to Webhook Requests
  2. Search for Webhook Requests using the criteria 
  3. 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
  4. From the Action Menu click on ACTIONS > DELETE
    ACTION DELETE FROM SUMMARY PAGEImage Removed
  5. Click on SAVE from the modalACTIONS > RESEND.
Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalseexcerpttrue
labelsworkflows-basics-r7,workflows-advanced-r7,workflows-admin-r7

spaceKey

Helpful Links

Panel
namegrey

Popular Labels

Popular Labels
Filter by label (Content by label)
heatmap
showLabelsfalse
spacesV4Manualstyle
showSpacefalse
labelsglobal