feedbackevent.schema.json

{
    "meta:license": [
        "Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/experience/campaign/feedbackevent",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Adobe Delivery Feedback Events",
    "type": "object",
    "meta:extensible": true,
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/experienceevent"
    ],
    "description": "Contains all delivery event fields.",
    "definitions": {
        "feedbackevent": {
            "properties": {
                "https://ns.adobe.com/experience/campaign/feedback/type": {
                    "title": "Feedback Type",
                    "type": "string",
                    "description": "The type of message event.",
                    "meta:titleId": "feedbackevent##https://ns.adobe.com/experience/campaign/feedback/type##title##87521",
                    "meta:descriptionId": "feedbackevent##https://ns.adobe.com/experience/campaign/feedback/type##description##66911"
                },
                "xdm:retryCount": {
                    "title": "Retry Count",
                    "type": "integer",
                    "description": "Number of failed attempts before the current event.",
                    "meta:titleId": "feedbackevent##xdm:retryCount##title##72331",
                    "meta:descriptionId": "feedbackevent##xdm:retryCount##description##27701"
                },
                "https://ns.adobe.com/experience/campaign/feedback/delivery": {
                    "title": "The campaign activity originating a message to a recipient.",
                    "type": "object",
                    "properties": {
                        "xdm:id": {
                            "title": "Delivery ID",
                            "type": "string",
                            "description": "The campaign activity originating this message.",
                            "meta:titleId": "feedbackevent##xdm:id##title##9651",
                            "meta:descriptionId": "feedbackevent##xdm:id##description##13501"
                        },
                        "xdm:campaignId": {
                            "title": "Campaign Id",
                            "type": "string",
                            "description": "Campaign of which this delivery was a part.",
                            "meta:titleId": "feedbackevent##xdm:campaignId##title##44731",
                            "meta:descriptionId": "feedbackevent##xdm:campaignId##description##8171"
                        },
                        "xdm:from": {
                            "title": "From",
                            "type": "string",
                            "description": "Address used as a from/sender/caller address. Depending on the communication channel, the `address` has a different format.\n\n  * `email`: an email address.\n  * `textMessage` or `phone`: a shortcode or phone number.",
                            "meta:titleId": "feedbackevent##xdm:from##title##3701",
                            "meta:descriptionId": "feedbackevent##xdm:from##description##50281"
                        },
                        "xdm:type": {
                            "title": "Delivery Type",
                            "type": "string",
                            "description": "Mode of delivery for the messages sent.",
                            "meta:titleId": "feedbackevent##xdm:type##title##40541",
                            "meta:descriptionId": "feedbackevent##xdm:type##description##53111"
                        },
                        "xdm:label": {
                            "title": "Delivery Label",
                            "type": "string",
                            "description": "A human-friendly name of the campaign activity which is originating this message.",
                            "meta:titleId": "feedbackevent##xdm:label##title##60961",
                            "meta:descriptionId": "feedbackevent##xdm:label##description##46681"
                        },
                        "xdm:name": {
                            "title": "Delivery Internal Name",
                            "type": "string",
                            "description": "A human-friendly identifier of the campaign activity which is originating this message.",
                            "meta:titleId": "feedbackevent##xdm:name##title##21761",
                            "meta:descriptionId": "feedbackevent##xdm:name##description##48161"
                        }
                    },
                    "meta:titleId": "feedbackevent##https://ns.adobe.com/experience/campaign/feedback/delivery##title##36671"
                },
                "https://ns.adobe.com/experience/campaign/feedback/message": {
                    "title": "A single message sent to a recipient.",
                    "type": "object",
                    "properties": {
                        "xdm:id": {
                            "title": "Message Identifier",
                            "type": "string",
                            "description": "Identifier of the message.",
                            "meta:titleId": "feedbackevent##xdm:id##title##58021",
                            "meta:descriptionId": "feedbackevent##xdm:id##description##4611"
                        },
                        "subject": {
                            "title": "Message Subject",
                            "type": "string",
                            "description": "Subject line of the message.",
                            "meta:titleId": "feedbackevent##subject##title##3701",
                            "meta:descriptionId": "feedbackevent##subject##description##54981"
                        },
                        "size": {
                            "title": "Message Size",
                            "type": "integer",
                            "description": "Size in bytes of the message.",
                            "meta:titleId": "feedbackevent##size##title##4621",
                            "meta:descriptionId": "feedbackevent##size##description##10651"
                        },
                        "recipient": {
                            "title": "The recipient of this message",
                            "type": "object",
                            "properties": {
                                "xdm:to": {
                                    "title": "To",
                                    "type": "string",
                                    "description": "Address used as a to/callee address. Depending on the communication channel, the `address` has a different format.\n\n  * `email`: an email address.\n  * `textMessage` or `phone`: a shortcode or phone number.",
                                    "meta:titleId": "feedbackevent##xdm:to##title##98651",
                                    "meta:descriptionId": "feedbackevent##xdm:to##description##58751"
                                },
                                "xdm:type": {
                                    "title": "Type",
                                    "type": "string",
                                    "description": "Whether this message message event describes the BCC, CC or To recipient.",
                                    "meta:titleId": "feedbackevent##xdm:type##title##65901",
                                    "meta:descriptionId": "feedbackevent##xdm:type##description##52831"
                                }
                            },
                            "meta:titleId": "feedbackevent##recipient##title##41241"
                        }
                    },
                    "meta:titleId": "feedbackevent##https://ns.adobe.com/experience/campaign/feedback/message##title##73511"
                },
                "https://ns.adobe.com/experience/campaign/feedback/messageFailure": {
                    "title": "Message Failure",
                    "type": "object",
                    "properties": {
                        "xdm:canonicalReason": {
                            "title": "Canonical Reason",
                            "type": "string",
                            "description": "Canonicalized text of the response returned by the remote server due to a failed delivery attempt.",
                            "meta:titleId": "feedbackevent##xdm:canonicalReason##title##49281",
                            "meta:descriptionId": "feedbackevent##xdm:canonicalReason##description##72271"
                        },
                        "xdm:reason": {
                            "title": "Reason",
                            "type": "string",
                            "description": "Unmodified, exact response returned by the remote server due to a failed delivery attempt.",
                            "meta:titleId": "feedbackevent##xdm:reason##title##24331",
                            "meta:descriptionId": "feedbackevent##xdm:reason##description##46081"
                        },
                        "xdm:errorCode": {
                            "title": "Error Code",
                            "type": "string",
                            "description": "Error code by which the remote server described a failed delivery attempt.",
                            "meta:titleId": "feedbackevent##xdm:errorCode##title##62201",
                            "meta:descriptionId": "feedbackevent##xdm:errorCode##description##9671"
                        },
                        "xdm:bounceType": {
                            "title": "Bounce Type",
                            "type": "string",
                            "description": "Classifies whether it is a soft bounce or hard bounce.",
                            "meta:titleId": "feedbackevent##xdm:bounceType##title##85541",
                            "meta:descriptionId": "feedbackevent##xdm:bounceType##description##7321"
                        },
                        "xdm:bounceClass": {
                            "title": "Bounce Class",
                            "type": "string",
                            "description": "Classification code for a given message.",
                            "meta:titleId": "feedbackevent##xdm:bounceClass##title##46331",
                            "meta:descriptionId": "feedbackevent##xdm:bounceClass##description##83171"
                        }
                    },
                    "meta:titleId": "feedbackevent##https://ns.adobe.com/experience/campaign/feedback/messageFailure##title##29901"
                },
                "https://ns.adobe.com/experience/campaign/feedback/solutionContext": {
                    "title": "Solution Context",
                    "type": "array",
                    "description": "List of solution specific key value pairs.",
                    "items": {
                        "$ref": "https://ns.adobe.com/experience/analytics/keyvalue"
                    },
                    "meta:titleId": "feedbackevent##https://ns.adobe.com/experience/campaign/feedback/solutionContext##title##48391",
                    "meta:descriptionId": "feedbackevent##https://ns.adobe.com/experience/campaign/feedback/solutionContext##description##18061"
                },
                "https://ns.adobe.com/experience/campaign/feedback/channel": {
                    "title": "Delivery channel",
                    "type": "object",
                    "properties": {
                        "xdm:type": {
                            "title": "Channel Type",
                            "type": "string",
                            "description": "Classifies whether the channel is email, push, sms.",
                            "meta:titleId": "feedbackevent##xdm:type##title##66621",
                            "meta:descriptionId": "feedbackevent##xdm:type##description##45761"
                        },
                        "email": {
                            "title": "E-mail Channel",
                            "type": "object",
                            "properties": {
                                "interactions": {
                                    "title": "User Interactions",
                                    "type": "object",
                                    "properties": {
                                        "xdm:spamType": {
                                            "title": "Spam Type",
                                            "type": "string",
                                            "description": "Type of spam report entered against this message (see RFC 5965 § 7.3).",
                                            "meta:titleId": "feedbackevent##xdm:spamType##title##78981",
                                            "meta:descriptionId": "feedbackevent##xdm:spamType##description##90271"
                                        },
                                        "xdm:reportedBy": {
                                            "title": "Reported By",
                                            "type": "string",
                                            "description": "E-mail Address of the entity reporting this message as spam.",
                                            "meta:titleId": "feedbackevent##xdm:reportedBy##title##91731",
                                            "meta:descriptionId": "feedbackevent##xdm:reportedBy##description##38351"
                                        },
                                        "xdm:reportTo": {
                                            "title": "Report To",
                                            "type": "string",
                                            "description": "E-mail Address to which this spam report is to be delivered.",
                                            "meta:titleId": "feedbackevent##xdm:reportTo##title##90131",
                                            "meta:descriptionId": "feedbackevent##xdm:reportTo##description##86451"
                                        },
                                        "xdm:userAgent": {
                                            "title": "User Agent",
                                            "type": "string",
                                            "description": "Value of the browser's User-Agent header.",
                                            "meta:titleId": "feedbackevent##xdm:userAgent##title##85711",
                                            "meta:descriptionId": "feedbackevent##xdm:userAgent##description##76961"
                                        }
                                    },
                                    "meta:titleId": "feedbackevent##interactions##title##39261"
                                },
                                "operationalContext": {
                                    "title": "Operational Context",
                                    "type": "object",
                                    "properties": {
                                        "xdm:outboundIP": {
                                            "title": "IP Address",
                                            "type": "string",
                                            "description": "Outbound IP address of the customer used to deliver the message.",
                                            "meta:titleId": "feedbackevent##xdm:outboundIP##title##11691",
                                            "meta:descriptionId": "feedbackevent##xdm:outboundIP##description##32721"
                                        },
                                        "xdm:sendProtocol": {
                                            "title": "Send Protocol",
                                            "type": "string",
                                            "description": "Protocol by which the message is delivered.",
                                            "meta:titleId": "feedbackevent##xdm:sendProtocol##title##77221",
                                            "meta:descriptionId": "feedbackevent##xdm:sendProtocol##description##15751"
                                        },
                                        "xdm:remoteIp": {
                                            "title": "IP Address",
                                            "type": "string",
                                            "oneOf": [
                                                {
                                                    "format": "ipv4"
                                                },
                                                {
                                                    "format": "ipv6"
                                                }
                                            ],
                                            "description": "IP address of the host to which this message is delivered.",
                                            "meta:titleId": "feedbackevent##xdm:remoteIp##title##71451",
                                            "meta:descriptionId": "feedbackevent##xdm:remoteIp##description##62391"
                                        },
                                        "xdm:mtaHost": {
                                            "title": "Node Name",
                                            "type": "string",
                                            "description": "Name of the MTA Instance originating the events.",
                                            "meta:titleId": "feedbackevent##xdm:mtaHost##title##5321",
                                            "meta:descriptionId": "feedbackevent##xdm:mtaHost##description##44431"
                                        },
                                        "xdm:mtaIp": {
                                            "title": "Sending IP Address",
                                            "type": "string",
                                            "oneOf": [
                                                {
                                                    "format": "ipv4"
                                                },
                                                {
                                                    "format": "ipv6"
                                                }
                                            ],
                                            "description": "IP address through which this message was sent.",
                                            "meta:titleId": "feedbackevent##xdm:mtaIp##title##40251",
                                            "meta:descriptionId": "feedbackevent##xdm:mtaIp##description##26591"
                                        },
                                        "xdm:queueTime": {
                                            "title": "Queue time",
                                            "type": "number",
                                            "description": "Delay, expressed in milliseconds, between this message's injection into SparkPost and its delivery to the receiving domain; that is, the length of time this message spent in the outgoing queue.",
                                            "meta:titleId": "feedbackevent##xdm:queueTime##title##78331",
                                            "meta:descriptionId": "feedbackevent##xdm:queueTime##description##16651"
                                        }
                                    },
                                    "meta:titleId": "feedbackevent##operationalContext##title##52921"
                                }
                            },
                            "meta:titleId": "feedbackevent##email##title##44831"
                        }
                    },
                    "meta:titleId": "feedbackevent##https://ns.adobe.com/experience/campaign/feedback/channel##title##91171"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/feedbackevent"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "feedbackevent##title##65261",
    "meta:descriptionId": "feedbackevent##description##85631"
}