Show / Hide Table of Contents

Namespace SuperOffice.CRM.Webhooks

Classes

CrmScriptWebhookPlugin

Webhooks for CRM Scripts. Call the scripts identified by the include id.

CustomWebhookPluginAttribute

Marks a custom webhook plugin ICustomWebhookPlugin - there can be many of these. These plugins are responsible for notifying other systems of events. They do not have to store/update webhook info. That's handled by the ISystemWebhookPlugin.

DefaultWebhookPlugin

Default webhook plugin. The plugin handles broadcasting the HTTP hooks to subscribing systems, and saving and storing the plugin info in the local database.

EventNames

Event names that don't fit into the normal, created, changed,deleted,soft-deleted types

RetryWebhook

SystemWebhookPluginAttribute

Marks a default webhook plugin ISystemWebhookPlugin - there is only one of these per system. The plugin is responsible for sending out and storing webhook information. The lowest priority wins.

Webhook

Describes a webhook for the ISystemWebhookPlugin.

WebhookDispatcher

Hosted Service responsible for processing the Webhook queue held by the WebhookManager. Calls WebhookManager.NotifyWebhooksAsync to process each item in the queue.

WebhookManager

Webhook manager. Queues webhooks and processes them on a background queue using the ISystemWebhookPlugin and ICustomWebhookPlugin.

WebhookPayload

Describes an event to be broadcast out over webhook or scripts, using the ISystemWebhookPlugin and ICustomWebhookPlugin systems.

WebhookResponse

WebhookSlowDispatcher

Hosted Service responsible for processing the slow Webhook queue held by the WebhookManager

WebhookSoftTriggerPlugin

Created by plugin system.

WebhookTaskInfo

WebhookTransmitter

Default implementation of IWebhookTransmitter

Interfaces

ICustomWebhookPlugin

Webhooks for custom systems. There may be several of these per system - these are not prioritized. All of them are instantiated and processed by the webhook dispatcher WebhookManager. Plugins must be marked with the CustomWebhookPluginAttribute to be found by the class factory.

ISystemWebhookPlugin

Webhook plugin - there is only one of these per system (as determined by the plugin priority). The plugin handles broadcasting the HTTP hooks to subscribing systems, and saving and storing the plugin info. Plugins must be marked with the CustomWebhookPluginAttribute to be found by the class factory.

IWebhookManager

Interface implemented by the WebhookManager class.

IWebhookTransmitter

Interface for implementing transmission of webhooks. Used by webhook plugins and retry processors.

Enums

ChangeType

Webhook event names

WebhookState

© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top