Struct WebhookEnvelope 

pub struct WebhookEnvelope {
    pub schema: u8,
    pub source_id: String,
    pub event_kind: String,
    pub body_json: Value,
    pub headers_subset: BTreeMap<String, String>,
    pub received_at_ms: i64,
    pub envelope_id: Uuid,
    pub client_ip: Option<IpAddr>,
}

Typed JSON envelope nexo publishes after every accepted webhook request.

Subscribers correlate events via envelope_id (deterministic dedup) and received_at_ms (late-binding analytics). headers_subset is a defensive allowlist — secrets like Authorization / Cookie / signature headers are stripped before publish, so a NATS subscriber sees only non-secret correlation IDs.

Unlike crate::BindingContext, this struct is intentionally not #[non_exhaustive]: it represents a wire-shape value constructed on both sides (the daemon writes it; tests + mocks build it via struct-literal). Field additions are semver-major because the JSON wire shape changes regardless.

Example

Microapps typically deserialise the envelope from a NATS payload:

use nexo_tool_meta::WebhookEnvelope;

let payload = serde_json::json!({
    "schema": 1,
    "source_id": "github_main",
    "event_kind": "pull_request",
    "body_json": {"action": "opened"},
    "headers_subset": {},
    "received_at_ms": 0,
    "envelope_id": "00000000-0000-0000-0000-000000000000",
    "client_ip": null
});
let env: WebhookEnvelope = serde_json::from_value(payload).unwrap();
assert_eq!(env.schema, 1);
assert_eq!(env.source_id, "github_main");

Fields

schema: u8

Wire-shape version. Always ENVELOPE_SCHEMA_VERSION.

source_id: String

Operator-assigned source identifier — matches the webhook_receiver.sources[].id YAML field.

event_kind: String

Event kind extracted from the inbound request (header or JSON body path, per source config).

body_json: Value

Inbound body, parsed as JSON. Non-JSON bodies are wrapped as { "raw_base64": "..." } upstream.

headers_subset: BTreeMap<String, String>

Allowlisted headers forwarded for downstream correlation. Authorization / Cookie / signature headers are stripped.

received_at_ms: i64

Server-side receipt timestamp in milliseconds since epoch.

envelope_id: Uuid

Random per-envelope identifier — useful for dedup.

client_ip: Option<IpAddr>

Resolved client IP (after trusted-proxy logic). None for envelopes built outside an HTTP request context.

Trait Implementations

impl Clone for WebhookEnvelope

fn clone(&self) -> WebhookEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebhookEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebhookEnvelope

fn eq(&self, other: &WebhookEnvelope) -> 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 WebhookEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for WebhookEnvelope

type WithoutGenerics = WebhookEnvelope

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = WebhookEnvelope

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.

impl StructuralPartialEq for WebhookEnvelope