Versions Compared

Old Version 1

changes.mady.by.user Persia Xenopoulou

Saved on

compared with

New Version 2

changes.mady.by.user Persia Xenopoulou

Saved on

Key

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

Find out how to create a new Webhook Requests -

Status
colourRed
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 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. third party systems through a webhook. Both successful and rejected requests are shown

  • Webhook Requests are triggered by the system based on the Webhook Requests 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 WEBHOOK REQUESTS > MANAGE Webhook RequestSWEBHOOK REQUESTS

Explaining Webhook Requests  Fields

NameDescription

Number

 The number of the Webhook Request.webhook request

Life Cycle State

The life cycle of the Webhook Requestwebhook request, which can be one of the following:

  • Successful
  • Rejected

Type

The type of the Webhook Request

  • Email
  • SMS

Entity

The name of the entity that was communicated through the Webhook Requestthe webhook

Entity ID

The ID of the entity that was communicated through the Webhook Requestthe webhook

SubjectURL

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 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 Requestthe webhook

Workflow Rule

The 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 Requestsrejected webhook

Error Description

The description of the error that occurred while sending the Webhook Requestthe webhook . This is applicable only for rejected Webhook Requestsrejected webhook

Log Information

Includes the standard log information 

Webhook Request Validations & Restrictions

ActionValidationsRestrictions
DELETE
  • 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 

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 view
    MANAGE ALERTS'Image Removed to resend to go to the data entry page
  4. From the Actions Menu click on ACTIONS > RESEND
    RESEND REJECTED REQUESTImage Added 
  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, to go to the Data Entry page
  4. From the Action Menu click on Delete
  5. Click Yes on the Confirmation message box
    DELETEImage Removed

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
    SELECT ALERTS TO BE DELETEDImage Removed

  5. Click on SAVE from the modal
    DELETE MULTIPLE ALERTSImage Removed

Panel
namegrey

Related Areas

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

Panel
namegrey

Popular Labels

Popular Labels
spaceKeyV4Manual
styleheatmap