Skip to end of banner
Go to start of banner

Managing Webhook Requests

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

AVAILABLE FROM CRM.COM R9.0.0

What does this section cover?

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. 

  • Webhook Requests are triggered by the system based on the Webhook Requests Definitions 
  • 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

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:

  • Successful
  • Rejected

Type

The type of the Webhook Request

  • Email
  • SMS

Entity

The name of the entity that was communicated through the Webhook Request

Entity ID

The ID of the entity that was communicated through 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 definition that was used to send the Webhook Request

Workflow Rule

The workflow rule that triggered the Webhook Request

Error Code

The code of the error that occurred while sending the Webhook Request. This is applicable only for rejected Webhook Requests

Error Description

The description of the error that occurred while sending the Webhook Request. This is applicable only for rejected Webhook Requests

Log Information

Includes the standard log information 

Webhook Request Validations & Restrictions

ActionValidations
DELETE
  • No validations

Creating a Webhook Requests

Webhook Requests are automatically created

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
    MANAGE ALERTS' 

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
    DELETE

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 DELETED
  5. Click on SAVE from the modal
    DELETE MULTIPLE ALERTS

Related Areas

Popular Labels

  • No labels