Panel | |
---|---|
|
...
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
The URL action facilitates the passing of matched Universal Event attributes as JSON in the body of the POST request.
URL Action JSON Properties
Property | Description |
---|---|
name | |
templateId | |
webhookName | |
attributes |
URL Action JSON Examples
Code Block | ||
---|---|---|
| ||
{ "attributes" : { "after_value_boolean" : true, "name" : "Custom Day Local Indicator Enabled", "updated_by" : "ops.admin", "before_value_boolean" : false, "after_value" : "true", "updated" : "2023-04-03 13:03:13 -0400", "before_value" : "false", "property_name" : "uc.custom_day.local_indicator.enabled" }, "name" : "uac_property_changed", "templateId" : "4dde3b099053409e81fcae415cb91c02", "webhookName" : "stonebranch-webhook-01" } |
Code Block | ||
---|---|---|
| ||
{
"attributes" : {
"hb_grace_period" : 60,
"agent_id" : "AGNT0001",
"log_level" : "Info",
"ip_address" : "127.0.1.1",
"version" : "7.4.0.0",
"suspended" : false,
"agent_type" : "Linux/Unix",
"decommissioned" : false,
"event_type" : "Updated",
"hb_intvl" : 120,
"build" : "51",
"transient" : false,
"name" : "stonebranch-agent-01 - AGNT0001",
"updated_by" : "ops.admin",
"updated" : "2023-04-03 13:32:57 -0400",
"host_name" : "stonebranch-agent-01",
"status" : "Active",
"agent_type_value" : 2
},
"name" : "uac_agent_changed",
"templateId" : "850d38176e944ca3ae49a3cb52f98cdb",
"webhookName" : "stonebranch-webhook-05"
}
|