Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.
TypeScript agentaiai-agentsall-in-onecrmcrm-systememaillinearmcpmessagingnotesnotionofficerustslackslack-alternativestartupstartup-toolstypescriptworkspace
//! Kafka event models for the `macro.webhooks` topic.
//!
//! Lifecycle events contain sanitized webhook configuration metadata. Signing
//! secrets and custom-header values are deliberately excluded from every
//! payload.
#[cfg(test)]
mod test;
use chrono::{DateTime, Utc};
use macro_event_broker::{Event, MacroEvent, TopicEvent};
use macro_event_topics::MacroWebhooksTopic;
use macro_user_id::user_id::MacroUserIdStr;
use serde::{Deserialize, Serialize};
use super::models::{WebhookFilters, WebhookStatus};
/// Metadata for [`WebhookTopicEvent::Created`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct WebhookCreatedMetadata {
/// Identifier of the created webhook.
pub webhook_id: String,
/// Identifier of the workspace that owns the webhook.
pub workspace_id: String,
/// Caller-chosen namespace, unique among the workspace's webhooks.
///
/// Defaults to an empty string when decoding schema-version-1 payloads
/// persisted before namespaces existed; serialized payloads always
/// include it.
#[serde(default)]
pub namespace: String,
/// Authenticated user who created the webhook.
pub created_by_user_id: MacroUserIdStr<'static>,
/// Display name of the webhook.
pub name: String,
/// URL that receives webhook deliveries.
pub endpoint_url: String,
/// Lifecycle status of the webhook.
pub status: WebhookStatus,
/// Whether the endpoint configuration has passed validation.
pub is_valid: bool,
/// Event and entity filters configured for the webhook.
pub filters: WebhookFilters,
/// Names of configured custom headers, with their values omitted.
pub header_names: Vec<String>,
/// Creation timestamp reported by the repository.
pub created_at: DateTime<Utc>,
}
/// Metadata for [`WebhookTopicEvent::Updated`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct WebhookUpdatedMetadata {
/// Identifier of the updated webhook.
pub webhook_id: String,
/// Identifier of the workspace that owns the webhook.
pub workspace_id: String,
/// Authenticated user who updated the webhook.
pub actor_user_id: MacroUserIdStr<'static>,
/// Requested display name, or `None` when the PATCH omitted it.
pub name: Option<String>,
/// Requested endpoint URL, or `None` when the PATCH omitted it.
pub endpoint_url: Option<String>,
/// Requested event filters, or `None` when the PATCH omitted them.
pub filters: Option<WebhookFilters>,
/// Whether the PATCH replaced custom headers; names and values are omitted.
pub headers_updated: bool,
/// Requested lifecycle status, or `None` when the PATCH omitted it.
pub status: Option<WebhookStatus>,
/// Lifecycle status before the update, present when `status` is present.
pub previous_status: Option<WebhookStatus>,
/// Whether the final endpoint configuration has passed validation.
pub is_valid: bool,
/// Update timestamp reported by the repository after the final mutation.
pub updated_at: DateTime<Utc>,
}
/// Metadata for [`WebhookTopicEvent::Deleted`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct WebhookDeletedMetadata {
/// Identifier of the deleted webhook.
pub webhook_id: String,
/// Identifier of the workspace that owned the webhook.
pub workspace_id: String,
/// Authenticated user who deleted the webhook.
pub actor_user_id: MacroUserIdStr<'static>,
}
/// Metadata for [`WebhookTopicEvent::Validated`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct WebhookValidatedMetadata {
/// Identifier of the validated webhook.
pub webhook_id: String,
/// Identifier of the workspace that owns the webhook.
pub workspace_id: String,
/// Authenticated user who requested validation.
pub actor_user_id: MacroUserIdStr<'static>,
/// Persisted endpoint validation outcome.
pub is_valid: bool,
/// HTTP status returned by the endpoint, when it responded.
pub response_status: Option<u16>,
/// Sanitized validation result message, when available.
pub message: Option<String>,
}
/// Lifecycle events published to [`MacroWebhooksTopic`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "event_type", content = "metadata")]
pub enum WebhookTopicEvent {
/// A webhook was created.
#[serde(rename = "webhook.created")]
Created(WebhookCreatedMetadata),
/// A webhook configuration was updated.
#[serde(rename = "webhook.updated")]
Updated(WebhookUpdatedMetadata),
/// A webhook was soft-deleted.
#[serde(rename = "webhook.deleted")]
Deleted(WebhookDeletedMetadata),
/// A webhook endpoint validation completed.
#[serde(rename = "webhook.validated")]
Validated(WebhookValidatedMetadata),
}
impl TopicEvent for WebhookTopicEvent {
type Topic = MacroWebhooksTopic;
const SCHEMA_VERSION: u8 = 1;
}
/// Publishable lifecycle event for [`MacroWebhooksTopic`], keyed by webhook id.
pub struct WebhookMacroEvent {
key: String,
event: Event<WebhookTopicEvent>,
}
impl WebhookMacroEvent {
/// Build a created event keyed by the created webhook id.
pub fn created(key: impl Into<String>, metadata: WebhookCreatedMetadata) -> Self {
Self::new(key, WebhookTopicEvent::Created(metadata))
}
/// Build an updated event keyed by the updated webhook id.
pub fn updated(key: impl Into<String>, metadata: WebhookUpdatedMetadata) -> Self {
Self::new(key, WebhookTopicEvent::Updated(metadata))
}
/// Build a deleted event keyed by the deleted webhook id.
pub fn deleted(key: impl Into<String>, metadata: WebhookDeletedMetadata) -> Self {
Self::new(key, WebhookTopicEvent::Deleted(metadata))
}
/// Build a validated event keyed by the validated webhook id.
pub fn validated(key: impl Into<String>, metadata: WebhookValidatedMetadata) -> Self {
Self::new(key, WebhookTopicEvent::Validated(metadata))
}
/// Build an event from a topic-specific lifecycle event.
pub fn new(key: impl Into<String>, event: WebhookTopicEvent) -> Self {
Self::with_event(key, Event::new(event))
}
/// Build an event from a pre-built envelope.
pub fn with_event(key: impl Into<String>, event: Event<WebhookTopicEvent>) -> Self {
Self {
key: key.into(),
event,
}
}
}
impl MacroEvent for WebhookMacroEvent {
type EventPayload = WebhookTopicEvent;
fn key(&self) -> &str {
&self.key
}
fn event(&self) -> &Event<Self::EventPayload> {
&self.event
}
fn from_event(key: String, event: Event<Self::EventPayload>) -> Self {
Self::with_event(key, event)
}
}
/// Any entity event deliverable to a webhook endpoint.
///
/// Serialized bodies carry an `event_type` tag naming the event (for example
/// `document.created` or `message.posted`) and a `metadata` object
/// with the event payload. Endpoint validation additionally sends a
/// `WebhookValidationTestEvent`, which is not part of this union.
#[cfg(any(feature = "ingestion", feature = "inbound"))]
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "inbound", derive(utoipa::ToSchema))]
#[serde(untagged)]
pub enum WebhookEvent {
/// Document lifecycle events from the `macro.documents` topic.
Document(documents::domain::events::DocumentTopicEvent),
/// Channel lifecycle events from the `macro.channels` topic.
Channel(channels::domain::broker_events::ChannelTopicEvent),
/// Access-checked call notifications from `macro.call_notifications`.
Call(call::domain::notification_events::CallNotificationEvent),
/// Message facts for channels and documents from the `macro.messages` topic.
Message(messages::outbound::broker::MessageTopicEvent),
/// Agent session lifecycle events from the `macro.agent_session_lifecycle`
/// topic.
AgentSession(agent_session::domain::events::AgentSessionLifecycleEvent),
}