Skip to main content

Input fields

additionalVendorData : JSONString

Optional JSON object for vendor-specific data that doesn't fit the structured event data fields. Stored separately from the structured fields.

clickedEventData : ClickedInput

Event data for CLICKED events.

deferredEventData : DeferredInput

Event data for DEFERRED events.

deliveryFailedEventData : DeliveryFailedInput

Event data for DELIVERY_FAILED events.

eventType : MessageEventType! required

The type of message event.

occurredAt : DateTime! required

The date and time this event occurred.

openedEventData : OpenedInput

Event data for OPENED events.

vendor : String! required

The name of the external messaging vendor.

vendorMessageId : String! required

The unique ID of the message in the external vendor's system. This must match a previously created external message.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "additionalVendorData": {"key": "value"}, "clickedEventData": ClickedInput, "deferredEventData": DeferredInput, "deliveryFailedEventData": DeliveryFailedInput, "eventType": "DELIVERED", "occurredAt": "1974-04-29T20:51:14.571306+00:00", "openedEventData": OpenedInput, "vendor": "true-fear-citizen-north-candidate", "vendorMessageId": "85258204" }