Table of Contents

Class WebhookEventAttribute

Namespace
BpNexT.Actions.Abstractions
Assembly
BpNexT.Actions.Abstractions.dll

Names a webhook event the module can emit. Put it on an IWebhookEvent payload type (exactly one per type, the preferred form), or on the module class for events emitted via the string-based EmitAsync(string, object, CancellationToken) overload (one attribute per event).

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false)]
public sealed class WebhookEventAttribute : Attribute
Inheritance
object
WebhookEventAttribute
Inherited Members
object.ToString()

Remarks

Event names are lowercase dotted identifiers like invoice.created (letters, digits, ., _, -); loading fails on invalid or duplicate names.

Constructors

WebhookEventAttribute(string)

Names a webhook event the module can emit. Put it on an IWebhookEvent payload type (exactly one per type, the preferred form), or on the module class for events emitted via the string-based EmitAsync(string, object, CancellationToken) overload (one attribute per event).

Properties

Description

What the event means and when it fires; shown in Studio.

Display

Human-readable name shown in Studio; falls back to Name.

Name

The event name receivers subscribe to, e.g. artikel.geaendert.

Methods

IsValidName(string)

Whether name is a valid event name.