| Panel | |
|---|---|
|
...
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.
Built-in Webhook variables are available for returning the name of the Webhook that launched the Task Instance and the JSON payload for the Webhook.
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.
To display more of the Details fields on the screen, you can either:
|
| Step 3 | Click a  button. The Webhook record is added to the database, and all buttons in the Webhook Details are enabled. |
| Note | ||
|---|---|---|
| ||
To open an existing record on the list, either:
|
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 | ||||||
|---|---|---|---|---|---|---|---|
| General | This section contains general information about the Webhook. | ||||||
| Name | User-defined name of this webhook. | ||||||
| Description | Description of this record. (Maximum = 255 characters.) | ||||||
| Member of Business Services |
| ||||||
| Details | This section contains detailed information about the Webhook. | ||||||
| Event | Type of Action (URL or Launch Task) to be taken when the event changes are published. | ||||||
| Action | Specifies the Universal Event Template to be monitored. Only System Templates are allowed. | ||||||
| HTTP Authentication | If 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. | ||||||
| URL | If Action is URL; Specifies the URL. | ||||||
| URL Query Parameters | If Action is URL; Specifies any query parameters to be encoded as a query string and appended to the URL. | ||||||
| HTTP Headers | If 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 | Specification of a filter for the specific type of Universal Event. | ||||||
| Metadata | This section contains Metadata information about this record. | ||||||
| UUID | Universally Unique Identifier of this record. | ||||||
| Updated By | Name of the user that last updated this record. | ||||||
| Updated | Date and time that this record was last updated. | ||||||
| Created By | Name of the user that created this record. | ||||||
| Buttons | This section identifies the buttons displayed above and below the Webhook Details that let you perform various actions. | ||||||
| Save | Saves a new Webhook record in the Controller database. | ||||||
| Save & New | Saves a new record in the Controller database and redisplays empty Details so that you can create another new record. | ||||||
| New | Displays empty (except for default values) Details for creating a new record. | ||||||
| Update | Saves updates to the record. | ||||||
| Delete | Deletes the current record. | ||||||
Enable | Enables the current Webhook. | ||||||
| Disable | Disables the current Webhook. | ||||||
| Refresh | Refreshes any dynamic data displayed in the Details. | ||||||
| Close | For pop-up view only; closes the pop-up view of this task. |
...
URL Action JSON Properties
| Property | Description | Data Type |
|---|---|---|
name | Name of the Universal Event. | string |
templateId | UUID of the Universal Event Template for the Universal Event. | string |
webhookName | Name of the Webhook that handled the matched Universal Event. | string |
attributes | Attributes of the Universal Event. The attributes object contains name/value pairs for each Attribute of the Universal Event. | object The Attribute value will be mapped to a data type using the Attribute type.
|
URL Action JSON Examples
...