Versions Compared

Key

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


Panel

Table of Contents

...

Creating a Webhook

Step 1

From the Services navigation pane, select Administration > Webhooks. The Webhooks list displays:

Step 2

Enter / select Details for a new Webhook, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.
  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.
  • Temporarily hide the list above the Details.
  • Click the   button above the list to display a pop-up version of the Details.
Step 3Click a  Image Modified  button. The Webhook record is added to the database, and all buttons in the Webhook Details are enabled.


Note
titleNote

To open an existing record on the list, either:

  • Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the  button that displays above and below the Details.)
  • Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
  • Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

Webhook Details

The following Webhook Details is for a new Webhook. See the field descriptions, below, for a description of all fields that display in the Webhook Details.

Webhook Details Field Descriptions

...

Field Name Description
GeneralThis section contains general information about the Webhook.
NameUser-defined name of this webhook.
Description

Description of this record. (Maximum = 255 characters.)

Member of Business Services
Include Page
IL:Member of Business Services
IL:Member of Business Services
Details This section contains detailed information about the Webhook.
Event Specifies the Universal Event Template to be monitored. Only System Templates are allowed. 
Action

Type of Action (URL or Launch Task) to be taken when the event changes are published.

HTTP AuthenticationIf Action is URL; Specifies the HTTP authentication scheme to use. 
Credentials 

If HTTP Authentication is Basic; Credentials for the URL. 

Click the details icon to create a new credentials record or view a selected credential's definition.

URLIf Action is URL; Specifies the URL.
URL Query ParametersIf Action is URL; Specifies any query parameters to be encoded as a query string and appended to the URL.
HTTP HeadersIf Action is URL; Specifies the HTTP headers.
Task

If Action is Launch Task; Select the task to execute.

Click the details icon to view the task definition.

Event Attribute CriteriaThis section contains criteria for selecting Universal Events to monitor.
  • Match All
  • Match Any

Specification of a filter for the specific type of Universal Event.

  • Match All
  • Match Any
Event Business Service CriteriaThis section contains criteria for selecting Universal Events to monitor by their business service membership.
  • Member of Any Business Service or Unassigned
  • Member of Specific Business Services or Unassigned 
  • Member of Specific Business Services 
  • Unassigned

Criteria for matching on Universal Events by their business service membership.

  • Member of Any Business Service or Unassigned

  • Member of Specific Business Services or Unassigned

    You must specify one or more business services from an Event Member of Business Services drop-down.
  • Member of Specific Business Services

    You must specify one or more business services from an Event Member of Business Services drop-down.
  • Unassigned

MetadataThis section contains Metadata information about this record.
UUIDUniversally Unique Identifier of this record.
Updated ByName of the user that last updated this record.
UpdatedDate and time that this record was last updated.
Created ByName of the user that created this record.
ButtonsThis section identifies the buttons displayed above and below the Webhook Details that let you perform various actions.
SaveSaves a new Webhook record in the Controller database.
Save & NewSaves a new record in the Controller database and redisplays empty Details so that you can create another new record.
NewDisplays empty (except for default values) Details for creating a new record.
UpdateSaves updates to the record.
DeleteDeletes the current record.

Enable

Enables the current Webhook.
DisableDisables the current Webhook.
RefreshRefreshes any dynamic data displayed in the Details.
CloseFor pop-up view only; closes the pop-up view of this task.

...