Versions Compared

Old Version 1

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 2

changes.mady.by.user Stonebranch

Saved on

Key

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


Panel

Table of Contents

Overview

You can register a third party webhook URL (or Task) to trigger when a specific built-in Universal Event is published. 

If your webhook URL requires an authentication method cannot be specified directly within the URL, you would register your webhook to launch an appropriately configured Web Service Task.

If you have a custom integration, you can register your webhook to launch an appropriately configured Universal Task.

To allow for the enforcement of read permission for Universal Events, the registration needs to have a security context. Registrations will support an enable and disable mechanism, as well as an ability to assign an Execution User.

If no Execution User is explicitly assigned, the registration will run under the security context of the user who enabled the registration.

In order for a registration to trigger, the Execution User must have the following authorization.

  • Read permission for the published Universal Event.

  • If a Task is specified instead of a URL, Launch permission for the Task.

  • If a Task is specified instead of a URL, any permissions required by the Task Instance, such as Execute permission for Credentials.


Creating a Webhook

Step 1

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

Image Added

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 Image Added button above the list to display a pop-up version of the Details.
Step 3Click a Image Added 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 Image Added 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.

Image Added

Webhook Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the Webhook Details.

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 
Action
HTTP AuthenticationIf Action is URL; Specifies the HTTP authentication scheme to use. 
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 Criteria