Interface DeliveryCustomFieldChangedMessagePayload

Generated when an existing Custom Field on a Delivery has been changed using the Set CustomField update action.

interface DeliveryCustomFieldChangedMessagePayload {
    deliveryId: string;
    name: string;
    previousValue?: any;
    type: "DeliveryCustomFieldChanged";
    value: any;
}

Properties

deliveryId name previousValue? type value

Properties

ReadonlydeliveryId

deliveryId: string

Unique identifier of the Delivery.

Readonlyname

name: string

Name of the Custom Field that changed.

Optional ReadonlypreviousValue

previousValue?: any

CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Delivery before, a Delivery Custom Field Added Message is generated instead.

Readonlytype

type: "DeliveryCustomFieldChanged"

Readonlyvalue

value: any

CustomFieldValue based on the FieldType after the Set CustomField update action.

Settings

Member Visibility

On This Page

Properties