Struct EventEnvelope 

pub struct EventEnvelope {
    pub event_id: EventId,
    pub event_type: String,
    pub repository: Repository,
    pub entity_type: EntityType,
    pub entity_id: Option<String>,
    pub session_id: Option<String>,
    pub payload: EventPayload,
    pub metadata: EventMetadata,
    pub trace_context: Option<TraceContext>,
}

Primary event container that wraps all GitHub events in a normalized format.

The EventEnvelope provides a consistent structure for all webhook events, regardless of their source event type. It includes metadata for routing, correlation, and session-based ordering.

Examples

use github_bot_sdk::events::{EventEnvelope, EventPayload, EntityType};
use github_bot_sdk::client::{Repository, RepositoryOwner, OwnerType};
use serde_json::json;
use chrono::Utc;

let payload = EventPayload::new(json!({"action": "opened"}));

let envelope = EventEnvelope::new(
    "pull_request".to_string(),
    repository,
    payload,
);

assert_eq!(envelope.event_type, "pull_request");
assert_eq!(envelope.entity_type, EntityType::PullRequest);

Fields

event_id: EventId

Unique identifier for this event

event_type: String

GitHub event type (e.g., “pull_request”, “issues”, “push”)

repository: Repository

Repository where the event occurred

entity_type: EntityType

Primary entity type involved in the event

entity_id: Option<String>

Identifier of the primary entity (e.g., PR number, issue number)

session_id: Option<String>

Session ID for ordered processing of related events

payload: EventPayload

Raw event payload from GitHub

metadata: EventMetadata

Processing and routing metadata

trace_context: Option<TraceContext>

Distributed tracing context

Implementations

impl EventEnvelope

pub fn new( event_type: String, repository: Repository, payload: EventPayload, ) -> Self

Create a new event envelope.

Examples

let payload = EventPayload::new(json!({"action": "opened"}));
let envelope = EventEnvelope::new("pull_request".to_string(), repository, payload);

pub fn with_session_id(self, session_id: String) -> Self

Add a session ID for ordered processing.

pub fn with_trace_context(self, context: TraceContext) -> Self

Add trace context for distributed tracing.

pub fn entity_key(&self) -> String

Get a unique key for the primary entity.

Returns a string in the format “repo:owner/name:entity_type:entity_id” for entities with IDs, or “repo:owner/name” for repository-level events.

pub fn correlation_id(&self) -> &str

Get the correlation ID for this event.

Returns the event ID as a string for correlation across system boundaries.

Trait Implementations

impl Clone for EventEnvelope

fn clone(&self) -> EventEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EventEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.