Interface IWebhookDefinitionBuilder

Namespace

Cratis.Chronicle.Webhooks

Assembly

Cratis.Chronicle.dll

Defines a builder for WebhookDefinition.

public interface IWebhookDefinitionBuilder

Methods

NotActive()

Specifies that the webhook is not active.

IWebhookDefinitionBuilder NotActive()

Returns

IWebhookDefinitionBuilder

The IWebhookDefinitionBuilder builder for continuation.

NotReplayable()

Specifies that the webhook is not replayable.

IWebhookDefinitionBuilder NotReplayable()

Returns

IWebhookDefinitionBuilder

The IWebhookDefinitionBuilder builder for continuation.

OnEventSequence(EventSequenceId)

Sets the EventSequenceId that the webhook observer should be registered on.

IWebhookDefinitionBuilder OnEventSequence(EventSequenceId eventSequenceId)

Parameters

eventSequenceId EventSequenceId

The EventSequenceId.

Returns

IWebhookDefinitionBuilder

The IWebhookDefinitionBuilder builder for continuation.

WithBasicAuth(string, string)

Use basic authentication.

IWebhookDefinitionBuilder WithBasicAuth(string username, string password)

Parameters

username string

The username.

password string

The password.

Returns

IWebhookDefinitionBuilder

The IWebhookDefinitionBuilder builder for continuation.

WithBearerToken(string)

Use bearer token authentication.

IWebhookDefinitionBuilder WithBearerToken(string token)

Parameters

token string

The bearer token.

Returns

IWebhookDefinitionBuilder

The IWebhookDefinitionBuilder builder for continuation.

WithEventType<TEventType>()

Adds an event type to the webhook observer.

IWebhookDefinitionBuilder WithEventType<TEventType>()

Returns

IWebhookDefinitionBuilder

The IWebhookDefinitionBuilder builder for continuation.

Type Parameters

TEventType

The Type of the event type.

WithHeader(string, string)

Adds a header to the webhook requests.

IWebhookDefinitionBuilder WithHeader(string key, string value)

Parameters

key string

The header key.

value string

The header value.

Returns

IWebhookDefinitionBuilder

The IWebhookDefinitionBuilder builder for continuation.