Class DBC.WebhookFields

Fields for Webhook, Webhook URL to call when events occur in the client or in NetServer. Also tracks call+error statistics.

Inheritance
Object
DBC.WebhookFields
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
public static class WebhookFields

Fields

ApplicationToken

Webhook.ApplicationToken: Application that registered this hook. If set, then other apps won't be able to modify this record

Declaration
public const string ApplicationToken = "application_token"
Field Value
Type Description
String

ConsecutiveErrors

Webhook.ConsecutiveErrors: Number of consecutive errors. Reset to 0 when an non-error is received. If too many errors, state is changed to TooManyErrors(3) to deactivate webhook.

Declaration
public const string ConsecutiveErrors = "consecutive_errors"
Field Value
Type Description
String

Events

Webhook.Events: Comma separated list of event names that this hook responds to: 'contact.created,person.changed,project.deleted'

Declaration
public const string Events = "events"
Field Value
Type Description
String

Headers

Webhook.Headers: Hook specific additional HTTP headers that should be added to HTTP request, stored as JSON blob

Declaration
public const string Headers = "headers"
Field Value
Type Description
String

LastError

Webhook.LastError: Most recent error message received from target. HTTP Headers + body. To help with debugging webhooks.

Declaration
public const string LastError = "last_error"
Field Value
Type Description
String

Name

Webhook.Name: Name to identify this webhook. Does not have to be unique.

Declaration
public const string Name = "name"
Field Value
Type Description
String

Properties

Webhook.Properties: Hook specific additional data that should be added to payload, stored as JSON blob

Declaration
public const string Properties = "properties"
Field Value
Type Description
String

Registered

Webhook.Registered: Registered when

Declaration
public const string Registered = "registered"
Field Value
Type Description
String

RegisteredAssociateId

Webhook.RegisteredAssociateId: Registered by whom

Declaration
public const string RegisteredAssociateId = "registered_associate_id"
Field Value
Type Description
String

Secret

Webhook.Secret: Shared secret key used for generating SHA256 HMAC signature, so that receiver can verify that call came from this server

Declaration
public const string Secret = "secret"
Field Value
Type Description
String

State

Webhook.State: Webhook status - should we post events to the URL? 1=Active, 2=Stopped or 3=TooManyErrors

Declaration
public const string State = "state"
Field Value
Type Description
String

TargetUrl

Webhook.TargetUrl: Destination to POST event info to. URL for webhooks. Id for CRM scripts

Declaration
public const string TargetUrl = "target_url"
Field Value
Type Description
String

TotalCalls

Webhook.TotalCalls: Number of times webhook has been invoked since registered. For statistical purposes.

Declaration
public const string TotalCalls = "total_calls"
Field Value
Type Description
String

TotalErrors

Webhook.TotalErrors: Number of times webhook has returned error since registered. For statistical purposes.

Declaration
public const string TotalErrors = "total_errors"
Field Value
Type Description
String

Type

Webhook.Type: Name of plugin that handles this webhook. 'webhook' for webhooks, which are handled by the system plugin.

Declaration
public const string Type = "type"
Field Value
Type Description
String

Updated

Webhook.Updated: Last updated when

Declaration
public const string Updated = "updated"
Field Value
Type Description
String

UpdatedAssociateId

Webhook.UpdatedAssociateId: Last updated by whom

Declaration
public const string UpdatedAssociateId = "updated_associate_id"
Field Value
Type Description
String

UpdatedCount

Webhook.UpdatedCount: Number of updates made to this record

Declaration
public const string UpdatedCount = "updatedCount"
Field Value
Type Description
String

WebhookId

Webhook.WebhookId: Primary key

Declaration
public const string WebhookId = "webhook_id"
Field Value
Type Description
String