Class WebhookRecordData

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the Webhook table.

Inheritance
object
WebhookRecordData
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class WebhookRecordData
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Constructors

WebhookRecordData()

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the Webhook table.

Declaration
public WebhookRecordData()
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Fields

ApplicationToken

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

Declaration
public string ApplicationToken
Field Value
Type Description
string
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ErrorsEmail

Email address to send error message to when this webhook state changes to too-many errors.

Declaration
public string ErrorsEmail
Field Value
Type Description
string
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Events

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

Declaration
public string Events
Field Value
Type Description
string
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Headers

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

Declaration
public string Headers
Field Value
Type Description
string
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Name

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

Declaration
public string Name
Field Value
Type Description
string
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Properties

Hook specific additional data that should be added to payload, stored as JSON blob

Declaration
public string Properties
Field Value
Type Description
string
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Registered

Registered when in UTC.

Declaration
public DateTime Registered
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegisteredAssociateId

Registered by whom

Declaration
public int RegisteredAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Secret

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

Declaration
public string Secret
Field Value
Type Description
string
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

State

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

Declaration
public WebhookState State
Field Value
Type Description
WebhookState
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

TargetUrl

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

Declaration
public string TargetUrl
Field Value
Type Description
string
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Type

Name of plugin that handles this webhook. 'webhook' for HTTP POST notifications, 'crmscript' for script invocations.

Declaration
public string Type
Field Value
Type Description
string
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Updated

Last updated when in UTC.

Declaration
public DateTime Updated
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedAssociateId

Last updated by whom

Declaration
public int UpdatedAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedCount

Number of updates made to this record

Declaration
public short UpdatedCount
Field Value
Type Description
short
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

WebhookId

Primary key

Declaration
public int WebhookId
Field Value
Type Description
int
Remarks

Please use this class instead of a full WebhookRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding WebhookTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extension Methods