Class TemplateEvent

Namespace

BoldSign.Api.Model.Webhook.Template

Assembly

BoldSign.Api.dll

The webhook template event object.

public class TemplateEvent : IWebhookData

Inheritance

object

TemplateEvent

Implements

IWebhookData

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ActivityBy

Gets or sets the activityBy.

[JsonProperty("activityBy")]
public string ActivityBy { get; set; }

Property Value

string

ActivityDate

Gets or sets the activityDate.

[JsonProperty("activityDate")]
[JsonConverter(typeof(UnixDateTimeConverter))]
public DateTime? ActivityDate { get; set; }

Property Value

DateTime?

AllowModifyFiles

Gets or sets a value indicating whether to allow senders to replace or delete files.

[JsonProperty("allowModifyFiles")]
public bool? AllowModifyFiles { get; set; }

Property Value

bool?

AllowNewFiles

Gets or sets a value indicating whether to allow new files while using this template to send a document.

[JsonProperty("allowNewFiles")]
public bool? AllowNewFiles { get; set; }

Property Value

bool?

BrandId

Gets or sets the selected brand.

[JsonProperty("brandId")]
public string BrandId { get; set; }

Property Value

string

CCDetails

Gets or sets the CC details.

[JsonProperty("ccDetails")]
public TemplateCc[] CCDetails { get; set; }

Property Value

TemplateCc[]

CreatedDate

Gets or sets the createdDate.

[JsonProperty("createdDate")]
[JsonConverter(typeof(UnixDateTimeConverter))]
public DateTime? CreatedDate { get; set; }

Property Value

DateTime?

EnableSigningOrder

Gets or sets a value indicating whether the SigningOrder is enabled.

[JsonProperty("enableSigningOrder")]
public bool EnableSigningOrder { get; set; }

Property Value

bool

ErrorMessage

Gets or sets the ErrorMessage.

Available only when the template send is failed.

[JsonProperty("errorMessage")]
public string ErrorMessage { get; set; }

Property Value

string

IsTemplate

Gets or sets a value indicating whether get or Set the isTemplate.

[JsonProperty("isTemplate")]
public bool IsTemplate { get; set; }

Property Value

bool

Labels

Gets or sets the document labels.

[JsonProperty("labels")]
public IEnumerable<string> Labels { get; set; }

Property Value

IEnumerable<string>

MessageTitle

Gets or sets the messageTitle.

[JsonProperty("messageTitle")]
public string MessageTitle { get; set; }

Property Value

string

ObjectType

Gets or sets the object name.

[JsonProperty("object")]
public string ObjectType { get; set; }

Property Value

string

OnBehalfOf

Gets or sets the on behalf of email.

[JsonProperty("onBehalfOf")]
public string OnBehalfOf { get; set; }

Property Value

string

SenderDetail

Gets or sets the document sender details.

[JsonProperty("senderDetail", DefaultValueHandling = DefaultValueHandling.Include)]
public TemplateSender SenderDetail { get; set; }

Property Value

TemplateSender

SignerDetails

Gets or sets the signerDetails.

[JsonProperty("signerDetails")]
public TemplateSigner[] SignerDetails { get; set; }

Property Value

TemplateSigner[]

Status

Gets or sets the status.

[JsonProperty("status")]
public DocumentStatus Status { get; set; }

Property Value

DocumentStatus

TemplateDescription

Gets or sets the templateDescription.

[JsonProperty("templateDescription")]
public string TemplateDescription { get; set; }

Property Value

string

TemplateId

Gets or sets templateId.

[JsonProperty("templateId")]
public string TemplateId { get; set; }

Property Value

string

TemplateLabels

Gets or sets the template labels.

[JsonProperty("templateLabels")]
public IEnumerable<string> TemplateLabels { get; set; }

Property Value

IEnumerable<string>

TemplateName

Gets or sets the templateName.

[JsonProperty("templateName")]
public string TemplateName { get; set; }

Property Value

string