Versions Compared

Old Version 7

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

Learn to work with Webhook Requests

Panel
nameblue

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.  

 

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 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 Request.

Main Information

Life Cycle State

The Life Cycle State of the Webhook Request, which is either:

  • Successful
  • Rejected

Entity

The Entity Number of the actual entry and the name of the Entity that was communicated through the Webhook, which can be:

  • Service Request
  • Activity
  • Subscription
  • Job

URL

The URL that was used by the Webhook 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.

Workflow Rule

The Workflow Rule that triggered the Webhook.

Error Code

The code of the error that occurred while sending the Webhook. This applies to rejected Webhooks only.

Error Description

The description of the error that occurred while sending the Webhook. This applies to rejected Webhooks only.

Log Information 

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.
  2. Search for the rejected request to resend and click on its Number to go to the Data Entry page.
  3. From the Actions Menu click on ACTIONS > RESEND.
Panel
namegrey

Related Areas

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

Panel
namegrey

Helpful Links

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelsglobal