Class Event

Class representing an EasyPost event.

Inheritance

System.Object

EphemeralEasyPostObject

EasyPostObject

Event

Implements

IEasyPostObject

Inherited Members

EasyPostObject.CreatedAt

EasyPostObject.Id

EasyPostObject.UpdatedAt

EasyPostObject.Prefix

EasyPostObject.AsDictionary()

EasyPostObject.ToString()

EasyPostObject.Equals(Nullable<Object>)

EasyPostObject.GetHashCode()

EphemeralEasyPostObject.Mode

EphemeralEasyPostObject.AsJson()

Namespace: EasyPost.Models.API

Assembly: EasyPost.dll

Syntax

public class Event : EasyPostObject, IEasyPostObject

Properties

CompletedUrls

Webhook URLs that have already been successfully notified as of the time the current webhook was sent.

Declaration

public List<string>? CompletedUrls { get; set; }

Property Value

Type	Description
System.Nullable<List<System.String>>

Description

The result type and event name. See https://docs.easypost.com/docs/events#possible-event-types for a list of possible values.

Declaration

public string? Description { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PendingUrls

Webhook URls that have not yet been successfully notified as of the time the current webhook was sent. The URL receiving this event will still be listed here.

Declaration

public List<string>? PendingUrls { get; set; }

Property Value

Type	Description
System.Nullable<List<System.String>>

PreviousAttributes

Any previous values of relevant result attributes.

Declaration

public Dictionary<string, object>? PreviousAttributes { get; set; }

Property Value

Type	Description
System.Nullable<Dictionary<System.String, System.Object>>

Result

The result of the event. See the "object" key to determine its specific type. This field will not be returned when retrieving events directly from the API.

Declaration

public Dictionary<string, object>? Result { get; set; }

Property Value

Type	Description
System.Nullable<Dictionary<System.String, System.Object>>

Status

The current status of the event. Possible values are "pending", "completed", "failed", "in_queue" and "retrying".

Declaration

public string? Status { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

UserId

The ID of the User associated with the event and Webhook.

Declaration

public string? UserId { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Implements

IEasyPostObject