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 | 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 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 Attribute Criteria | This section contains criteria for selecting Universal Events to monitor. | ||||||
| Specification of a filter for the specific type of Universal Event.
| ||||||
Event Business Service Criteria | This section contains criteria for selecting Universal Events to monitor by their business service membership. | ||||||
| Criteria for matching on Universal Events by their business service membership.
| ||||||
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. |
...
Code Block | ||
---|---|---|
| ||
{ "attributes" : { "attempt" : 1, "calendar_id" : "77171434c0a801c9016d5b2b5d17ddee", "created" : "2024-03-11 15:01:39 -0400", "current_retry_count" : 0, "early_finished" : false, "execution_user" : "YanAdmin", "exit_code" : "0", "instance_id" : "1710013567491690711LXITAWF41VSXZ", "instance_name" : "stonebranch-timertask-01", "instance_number" : 2, "invoked_by" : "Manually Launched", "late_finished" : true, "late_started" : true, "launch_source" : "Launch Task / User Interface", "launch_time" : "2024-03-11 15:01:39 -0400", "maximum_retries" : 0, "retry_indefinitely" : false, "security_name" : "stonebranch-timertask-01", "simulate" : false, "sla_type" : "Finished Late", "source_version" : 17, "start_time" : "2024-03-11 15:01:39 -0400", "state_changed_time" : "2024-03-11 15:01:39 -0400", "status" : "Running", "status_value" : 80, "task_id" : "f0f47f5fdc264c3f8d78e76e794863ca", "type" : "Timer", "type_value" : 2, "updated" : "2024-03-11 15:01:39 -0400" }, "businessServices" : [ ], "name" : "uac_task_sla", "templateId" : "69372756e6ec401d8162621f61c611eb", "webhookName" : "stonebranch-webhook-05" } |
...