Table of Contents

Table Sys_Web_Hooks

Entity

Entity: Systems.Config.WebHooks

Webhook templates. Activated by business rules or other means. Entity: Sys_Web_Hooks (Introduced in version 22.1.5.8)

Summary

Name Type Description
Body nvarchar(max) The body of the POST request (interpolated string).
Code nvarchar(32)
Headers nvarchar(max) Optional headers for the request (interpolated string). Each header is specified on a separate line.
Name nvarchar(254) ML Webhook name (multi-language).
Notes nvarchar(max)
Repository_Name nvarchar(128) The name of the repository for which the webhook is setup. All interpolated strings will be evaluated in the context of entities of the specified type.
Retry_Logic nvarchar(1) Allowed: 0, 3 0=Don't retry (default); 3=Retry up to 3 times
Row_Version timestamp
URL nvarchar(2000) The destination URL, which should be called by the webhook (interpolated string).
Web_Hook_Id uniqueidentifier PK

Columns

Body

The body of the POST request (interpolated string).

Property Value
Attributes IsLongString
Auto Complete no
Data Filter no
Default Value None
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length 2147483647
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key no
Readonly no
RTF no
Sortable no
Summary Type None
Supports EQUALS_IN no
Type nvarchar(max) (Allows NULL)
UI Memo Editor no
UI Width Medium
User Login no
Visible yes

Code

Property Value
Auto Complete no
Data Filter no
Default Value None
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length 32
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key no
Readonly no
RTF no
Sortable yes
Summary Type None
Supports EQUALS_IN no
Type nvarchar(32)
UI Memo Editor no
UI Width Medium
User Login no
Visible yes

Code - Supported Filters

Filter Type Default Include Nulls Hidden by Default
Equals NULL no no
Like None no no

Headers

Optional headers for the request (interpolated string). Each header is specified on a separate line.

Property Value
Attributes IsLongString
Auto Complete no
Data Filter no
Default Value None
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length 2147483647
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key no
Readonly no
RTF no
Sortable no
Summary Type None
Supports EQUALS_IN no
Type nvarchar(max) (Allows NULL)
UI Memo Editor no
UI Width Medium
User Login no
Visible yes

Name

Webhook name (multi-language).

Property Value
Auto Complete no
Data Filter no
Default Value None
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length 254
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key no
Readonly no
RTF no
Sortable no
Summary Type None
Supports EQUALS_IN no
Type nvarchar(254) (MultiLanguage)
UI Memo Editor no
UI Width Medium
User Login no
Visible yes

Name - Supported Filters

Filter Type Default Include Nulls Hidden by Default
Like None no no

Notes

Property Value
Attributes IsLongString
Auto Complete no
Data Filter no
Default Value None
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length 2147483647
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key no
Readonly no
RTF no
Sortable no
Summary Type None
Supports EQUALS_IN no
Type nvarchar(max) (Allows NULL)
UI Memo Editor no
UI Width Medium
User Login no
Visible yes

Repository_Name

The name of the repository for which the webhook is setup. All interpolated strings will be evaluated in the context of entities of the specified type.

Property Value
Auto Complete no
Data Filter no
Default Value None
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length 128
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key no
Readonly no
RTF no
Sortable no
Summary Type None
Supports EQUALS_IN no
Type nvarchar(128)
UI Memo Editor no
UI Width Medium
User Login no
Visible yes

Repository_Name - Supported Filters

Filter Type Default Include Nulls Hidden by Default
Equals NULL no no
Like None no no

Retry_Logic

0=Don't retry (default); 3=Retry up to 3 times

Property Value
Allowed Values 0, 3
Auto Complete no
Data Filter no
Default Value 0
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length 1
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key no
Readonly no
RTF no
Sortable no
Summary Type None
Supports EQUALS_IN no
Type nvarchar(1)
UI Memo Editor no
UI Width Medium
User Login no
Visible yes

Row_Version

Property Value
Auto Complete no
Data Filter no
Default Value None
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length -1
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key no
Readonly no
RTF no
Sortable no
Summary Type None
Supports EQUALS_IN no
Type timestamp
UI Memo Editor no
UI Width Medium
User Login no
Visible no

URL

The destination URL, which should be called by the webhook (interpolated string).

Property Value
Auto Complete no
Data Filter no
Default Value None
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length 2000
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key no
Readonly no
RTF no
Sortable no
Summary Type None
Supports EQUALS_IN no
Type nvarchar(2000)
UI Memo Editor no
UI Width Medium
User Login no
Visible yes

Web_Hook_Id

Property Value
Auto Complete no
Data Filter no
Default Value NewGuid
Enter Stop yes
Ignore for Insert Order no
Is Entity Name no
Max Length -1
Order 2147483647
Ownership Reference no
Pasword no
Picture no
Primary Key yes (order: 1)
Readonly no
RTF no
Sortable no
Summary Type None
Supports EQUALS_IN yes
Type uniqueidentifier
UI Memo Editor no
UI Width Medium
User Login no
Visible no

Web_Hook_Id - Supported Filters

Filter Type Default Include Nulls Hidden by Default
Equals NULL no no