Class CmsWebHookDefinition

The Object Type 210. This object type specifies configuration objects for the 'Web Hooks Service'. This enables web applications to get notified about specific 'Nova Events'. A 'Web Hook Definition' defines which 'Nova Event' to subscribe, an event condition, how to transform the event's JSON payload and which external API is to be called

Inheritance

object

CmsObject

CmsWebHookDefinition

Inherited Members

CmsObject.Meta

CmsObject.Values

CmsObject.GetValue(int, int, int)

CmsObject.GetValues(int, int, int)

CmsObject.SetValue(CmsValue)

CmsObject.SetValues(int, int, int, IEnumerable<CmsValue>)

CmsObject.GetValue<T>(int, int, int)

CmsObject.SetValue<T>(int, int, int, T)

CmsObject.GetValues<T>(int, int, int)

CmsObject.SetValues<T>(int, int, int, IEnumerable<T>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Noxum.Nova.Cms.Client

Assembly: Noxum.Nova.Cms.Client.dll

Syntax

public class CmsWebHookDefinition : CmsObject

Properties

WebHookCondition

Get or set value of attribute 20104

Declaration

public string WebHookCondition { get; set; }

Property Value

Type	Description
string

WebHookErrorMessage

Get or set value of attribute 20107

Declaration

public string WebHookErrorMessage { get; set; }

Property Value

Type	Description
string

WebHookEventSubject

Get or set value of attribute 20101

Declaration

public string WebHookEventSubject { get; set; }

Property Value

Type	Description
string

WebHookExternalApiRef

Get or set value of attribute 20102

Declaration

public int? WebHookExternalApiRef { get; set; }

Property Value

Type	Description
int?

WebHookIsActive

Get or set value of attribute 20106

Declaration

public bool? WebHookIsActive { get; set; }

Property Value

Type	Description
bool?

WebHookTransformation

Get or set value of attribute 20105

Declaration

public string WebHookTransformation { get; set; }

Property Value

Type	Description
string

WebHookUsePost

Get or set value of attribute 20103

Declaration

public bool? WebHookUsePost { get; set; }

Property Value

Type	Description
bool?

Methods

GetAttributeDescription(int)

Get value of attribute 1012

Declaration

public string GetAttributeDescription(int language)

Parameters

Type	Name	Description
int	language

Returns

Type	Description
string

GetAttributeName(int)

Get value of attribute 1000

Declaration

public string GetAttributeName(int language)

Parameters

Type	Name	Description
int	language

Returns

Type	Description
string

SetAttributeDescription(int, string)

Set value of attribute 1012

Declaration

public void SetAttributeDescription(int language, string value)

Parameters

Type	Name	Description
int	language
string	value

SetAttributeName(int, string)

Set value of attribute 1000

Declaration

public void SetAttributeName(int language, string value)

Parameters

Type	Name	Description
int	language
string	value