Struct MessageIn

pub struct MessageIn {
    pub application: Option<Box<ApplicationIn>>,
    pub channels: Option<Vec<String>>,
    pub event_id: Option<String>,
    pub event_type: String,
    pub payload: Value,
    pub payload_retention_hours: Option<i64>,
    pub payload_retention_period: Option<i64>,
    pub tags: Option<Vec<String>>,
    pub transformations_params: Option<Value>,
}

Fields

application: Option<Box<ApplicationIn>>

channels: Option<Vec<String>>

List of free-form identifiers that endpoints can filter by

event_id: Option<String>

Optional unique identifier for the message

event_type: String

The event type’s name

payload: Value

JSON payload to send as the request body of the webhook. We also support sending non-JSON payloads. Please contact us for more information.

payload_retention_hours: Option<i64>

Optional number of hours to retain the message payload. Note that this is mutually exclusive with payloadRetentionPeriod.

payload_retention_period: Option<i64>

Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with payloadRetentionHours.

tags: Option<Vec<String>>

List of free-form tags that can be filtered by when listing messages

transformations_params: Option<Value>

Extra parameters to pass to Transformations (for future use)

Implementations

impl MessageIn

pub fn new_raw_payload(event_type: String, payload: String) -> Self

Create a new message with a pre-serialized payload.

The payload is not normalized on the server. Normally, payloads are required to be JSON, and Svix will minify the payload before sending the webhook (for example, by removing extraneous whitespace or unnecessarily escaped characters in strings). With this constructor, the payload will be sent “as is”, without any minification or other processing.

The default content-type of application/json will still be used for the webhook sent by Svix, unless overwritten with with_content_type.

pub fn with_content_type(self, content_type: String) -> Self

Set the content-type header to use for the webhook sent by Svix.

impl MessageIn

pub fn new(event_type: String, payload: Value) -> MessageIn

Trait Implementations

impl Clone for MessageIn

fn clone(&self) -> MessageIn

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MessageIn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MessageIn

fn default() -> MessageIn

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessageIn

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MessageIn

fn eq(&self, other: &MessageIn) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MessageIn

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MessageIn