Search Results for

    Show / Hide Table of Contents

    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
    IValidatableObject
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: mailslurp.Model
    Assembly: mailslurp.dll
    Syntax
    [DataContract(Name = "WebhookEmailOpenedPayload")]
    public class WebhookEmailOpenedPayload : IValidatableObject

    Constructors

    View Source

    WebhookEmailOpenedPayload()

    Initializes a new instance of the WebhookEmailOpenedPayload class.

    Declaration
    [JsonConstructor]
    protected WebhookEmailOpenedPayload()
    View Source

    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).

    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.

    Guid inboxId

    Id of the inbox (required).

    Guid pixelId

    ID of the tracking pixel (required).

    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

    View Source

    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

    View Source

    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.

    View Source

    InboxId

    Id of the inbox

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

    Id of the inbox

    View Source

    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.

    View Source

    PixelId

    ID of the tracking pixel

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

    ID of the tracking pixel

    View Source

    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

    View Source

    SentEmailId

    ID of sent email

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

    ID of sent email

    View Source

    WebhookId

    ID of webhook entity being triggered

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

    ID of webhook entity being triggered

    View Source

    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

    View Source

    ToJson()

    Returns the JSON string presentation of the object

    Declaration
    public virtual string ToJson()
    Returns
    Type Description
    string

    JSON string presentation of the object

    View Source

    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()

    Implements

    IValidatableObject
    • View Source
    In this article
    Back to top See MailSlurp website for more information.