Class WebhookEmailOpenedPayload

EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when an email containing a tracking pixel is opened and the pixel image is loaded by a reader.

Inheritance

object

WebhookEmailOpenedPayload

Implements

IEquatable<WebhookEmailOpenedPayload>

System.ComponentModel.DataAnnotations.IValidatableObject

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "WebhookEmailOpenedPayload")]
public class WebhookEmailOpenedPayload : IEquatable<WebhookEmailOpenedPayload>, IValidatableObject

Constructors

WebhookEmailOpenedPayload()

Initializes a new instance of the WebhookEmailOpenedPayload class.

Declaration

[JsonConstructor]
protected WebhookEmailOpenedPayload()

WebhookEmailOpenedPayload(string, Guid, EventNameEnum, string, Guid, Guid, Guid, string, DateTime)

Initializes a new instance of the WebhookEmailOpenedPayload class.

Declaration

public WebhookEmailOpenedPayload(string messageId = null, Guid webhookId = default, WebhookEmailOpenedPayload.EventNameEnum eventName = (WebhookEmailOpenedPayload.EventNameEnum)0, string webhookName = null, Guid inboxId = default, Guid pixelId = default, Guid sentEmailId = default, string recipient = null, DateTime createdAt = default)

Parameters

Type	Name	Description
string	messageId	Idempotent message ID. Store this ID locally or in a database to prevent message duplication. (required).
System.Guid	webhookId	ID of webhook entity being triggered (required).
WebhookEmailOpenedPayload.EventNameEnum	eventName	Name of the event type webhook is being triggered for. (required).
string	webhookName	Name of the webhook being triggered.
System.Guid	inboxId	Id of the inbox (required).
System.Guid	pixelId	ID of the tracking pixel (required).
System.Guid	sentEmailId	ID of sent email (required).
string	recipient	Email address for the recipient of the tracking pixel (required).
DateTime	createdAt	Date time of event creation (required).

Properties

CreatedAt

Date time of event creation

Declaration

[DataMember(Name = "createdAt", IsRequired = true, EmitDefaultValue = true)]
public DateTime CreatedAt { get; set; }

Property Value

Type	Description
DateTime	Date time of event creation

EventName

Name of the event type webhook is being triggered for.

Declaration

[DataMember(Name = "eventName", IsRequired = true, EmitDefaultValue = true)]
public WebhookEmailOpenedPayload.EventNameEnum EventName { get; set; }

Property Value

Type	Description
WebhookEmailOpenedPayload.EventNameEnum	Name of the event type webhook is being triggered for.

InboxId

Id of the inbox

Declaration

[DataMember(Name = "inboxId", IsRequired = true, EmitDefaultValue = true)]
public Guid InboxId { get; set; }

Property Value

Type	Description
System.Guid	Id of the inbox

MessageId

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

Declaration

[DataMember(Name = "messageId", IsRequired = true, EmitDefaultValue = true)]
public string MessageId { get; set; }

Property Value

Type	Description
string	Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

PixelId

ID of the tracking pixel

Declaration

[DataMember(Name = "pixelId", IsRequired = true, EmitDefaultValue = true)]
public Guid PixelId { get; set; }

Property Value

Type	Description
System.Guid	ID of the tracking pixel

Recipient

Email address for the recipient of the tracking pixel

Declaration

[DataMember(Name = "recipient", IsRequired = true, EmitDefaultValue = true)]
public string Recipient { get; set; }

Property Value

Type	Description
string	Email address for the recipient of the tracking pixel

SentEmailId

ID of sent email

Declaration

[DataMember(Name = "sentEmailId", IsRequired = true, EmitDefaultValue = true)]
public Guid SentEmailId { get; set; }

Property Value

Type	Description
System.Guid	ID of sent email

WebhookId

ID of webhook entity being triggered

Declaration

[DataMember(Name = "webhookId", IsRequired = true, EmitDefaultValue = true)]
public Guid WebhookId { get; set; }

Property Value

Type	Description
System.Guid	ID of webhook entity being triggered

WebhookName

Name of the webhook being triggered

Declaration

[DataMember(Name = "webhookName", EmitDefaultValue = true)]
public string WebhookName { get; set; }

Property Value

Type	Description
string	Name of the webhook being triggered

Methods

Equals(WebhookEmailOpenedPayload)

Returns true if WebhookEmailOpenedPayload instances are equal

Declaration

public bool Equals(WebhookEmailOpenedPayload input)

Parameters

Type	Name	Description
WebhookEmailOpenedPayload	input	Instance of WebhookEmailOpenedPayload to be compared

Returns

Type	Description
bool	Boolean

Equals(object)

Returns true if objects are equal

Declaration

public override bool Equals(object input)

Parameters

Type	Name	Description
object	input	Object to be compared

Returns

Type	Description
bool	Boolean

Overrides

Object.Equals(Object)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hash code

Overrides

Object.GetHashCode()

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Validate(ValidationContext)

To validate all properties of the instance

Declaration

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)

Parameters

Type	Name	Description
ValidationContext	validationContext	Validation context

Returns

Type	Description
IEnumerable<ValidationResult>	Validation Result

Implements

System.IEquatable<T>

System.ComponentModel.DataAnnotations.IValidatableObject