Table of Contents

Systems.Config.WebHooks Entity

Namespace: Systems.Config

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

Renames

Old name: Systems.Core.WebHooks
New name: Systems.Config.WebHooks
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Attributes

Name Type Description
Body string (max) nullable The body of the POST request (interpolated string).
Code string (32) The unique code of the WebHook. Required Filter(eq;like) ORD
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Headers string (max) nullable Optional headers for the request (interpolated string). Each header is specified on a separate line.
Id guid
Name MultilanguageString (254) Webhook name (multi-language). Required Filter(like)
Notes string (max) nullable Notes for this WebHook.
ObjectVersion int32 The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
RepositoryName string (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. Required Filter(eq;like)
RetryLogic RetryLogic 0=Don't retry (default); 3=Retry up to 3 times. Required Default("0")
URL string (2000) The destination URL, which should be called by the webhook (interpolated string). Required

Attribute Details

Body

The body of the POST request (interpolated string).

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

Code

The unique code of the WebHook. Required Filter(eq;like) ORD

Type: string (32)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 32
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Headers

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

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Name

Webhook name (multi-language). Required Filter(like)

Type: MultilanguageString (254)
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

Notes

Notes for this WebHook.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

RepositoryName

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. Required Filter(eq;like)

Type: string (128)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

RetryLogic

0=Don't retry (default); 3=Retry up to 3 times. Required Default("0")

Type: RetryLogic
Category: System
Allowed values for the RetryLogic(Systems.Config.WebHooks.md#retrylogic) data attribute
Allowed Values (Systems.Config.WebHooksRepository.RetryLogic Enum Members)

Value Description
NoRetry NoRetry value. Stored as '0'.
Database Value: '0'
Model Value: 0
Domain API Value: 'NoRetry'
Retry Retry value. Stored as '3'.
Database Value: '3'
Model Value: 1
Domain API Value: 'Retry'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: NoRetry
Show in UI: ShownByDefault

URL

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

Type: string (2000)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2000
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

  • customPropertyCode
    The code of the custom property
    Type: string

  • search
    The search text - searches by value or description. Can contain wildcard character %.
    Type: string
    Optional: True
    Default Value: null

  • exactMatch
    If true the search text should be equal to the property value
    Type: boolean
    Optional: True
    Default Value: False

  • orderByDescription
    If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
    Type: boolean
    Optional: True
    Default Value: False

  • top
    The top clause - default is 10
    Type: int32
    Optional: True
    Default Value: 10

  • skip
    The skip clause - default is 0
    Type: int32
    Optional: True
    Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Config_WebHooks?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Config_WebHooks?$top=10

Suggest improvement to this page