Configuring Webhook Definitions

Owned by Persia Xenopoulou (Deactivated)
Last updated: Jul 17, 2017 by Former user (Deleted)
3 min read

Back to Workflows Main Page

Table of Contents

Navigating to Webhook Definitions

FOUNDATION > WORKFLOWS > SET UP AND MANAGE WEBHOOKS > SET UP WEBHOOK DEFINITIONS

What are Webhook Definitions?

Webhooks are used in order to pass information to third party systems without CRM.COM integration. Webhooks consist of the URL that will be used to send the information to, and the actual information that will be transmitted. Webhook Definitions are used to define the business rules related to the available Webhooks.  Approval Definitions must be added on Workflow Rules, from where the Definitions are triggered to create the Webhooks.

Webhook Definitions can be edited, deleted and have their Life Cycle State changed.

  • Navigate to Webhook Definitions and explore existing entries via the Summary page. 

  • Click on the link (Name or Number) of the entry of your interest to access the Data Entry page and see more detail.

  • Use the Actions Menu to create a NEW Definition, modify (EDIT), or DELETE an existing one.  

  • Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Definition. 

Check the Validations & Restrictions Table below for a list of available Actions when working with Webhooks, including each Action's related validations and additional information.  View the Attributes Table for a comprehensive description of the Webhook Definition fields.

Webhook Definitions

Validations & Restrictions

ActionValidationsAdditional Information
General
  •  Not Applicable
  • Both 'Effective' or 'Not Effective' Webhook Definitions can be selected andaddedonaWorkflow Rule, but only 'Effective' Definitions are triggered to send Webhooks
Create
  • Name and Alternative Code must be unique.
  • Mandatory Fields must be defined.
  • Not Applicable
Edit
  • Name and Alternative Code must be unique.
  • Mandatory Fields must be defined.
  • Not Applicable
Delete
  • Definition can be deleted only if it is not added to a Workflow Rule
  • Not Applicable
Setting Life Cycle State to Not Effective
  • Not Applicable
If the Webhook Definition  is used in one or more 'Effective' Workflow Rule, then the System displays a warning that the Definition is used by Workflow Rules and confirmation is required before setting the Definition to 'Not Effective.'

Attributes

An * indicates a field is mandatory 

NameDescription
Main Information

Name*

 The name of the Webhook Definition.

Alternative Code *

The alternative code of the Webhook Definition. It is mandatory and unique and unless otherwise specified, the Alternative Codes for new entries default to the Name initials in capital letters.

Description

The description of the Webhook Definition.

Life Cycle State *

The Life Cycle State of the Webhook Definition, which can be one of the following:

  • Not Effective
  • Effective

On creating a new Webhook Definition the Life Cycle State is automatically set to 'Not Effective'. Only 'Effective' Webhook Definitions can be triggered through Workflow Rules, although 'Not Effective' ones can be defined in a Workflow Rule.

Settings

Entity*

The entity that will be communicated through the Webhook. The available options are:

  • Activities
  • Jobs
  • Service Requests
  • Subscription

More than one Webhook Definition can be defined for each entity.

Logging Method*

Determines which Webhook Requests created using the Definition will be logged:

  • Log Rejected Webhook Requests only (default): Only Webhook Requests that were rejected will be logged.
  • Log all Webhook Requests: All the Webhook Requests will be logged.

URL*

The URL that will be used to send the Webhook.

Secret Key*

The Secret Key that will be used for authentication by the third party system.

The allowed options must have matched URL and Secret Key endpoints as well as Webhook Key Types

Fields Set

The set of fields that should be sent through the Webhook. The set of available fields includes all the fields which are retrieved through the 'show Web API method' of the related entity.

The fields to be sent are defined manually, by specifying the comma-separated name of each field (as it is done through the Web API).

If this information is not specified, then all the available fields will be sent.

Workflow Rules

Workflow Rules

Displays a list of all the Workflow Rules that include the specific Webhook Definition as one of their actions. This information is Read-only.

Log Information
Log DetailsThe standard set of Log Details information available in all entities  

Additional Actions for Webhook Definition

Testing Webhook Connection

Once the Webhook Definition is set up, the connection can be tested to confirm that the emails will be sent successfully. Follow the steps below to test the Definition setup:

  1. Navigate to WEBHOOK DEFINITIONS.
  2. Search for the Definition you would like to Test and click on its Name to go to the Data Entry page.
  3. From the Actions Menu click on ACTIONS > TEST CONNECTION.
    1. Entity: Search and add a record of the entity for which the Webhook Definition has been set up.
    2. Click on SUBMIT TEST.
      If the test is Successful, the request and response to be created are displayed.  
      The Request is the data included in the Fields Set.
      If the test Failed, a Message appears that the information provided is wrong .

View Understanding Workflows for business examples related to Webhook Definitions.

Related Areas

Helpful Links