Struct Webhook 

pub struct Webhook {
    pub id: WebhookId,
    pub description: Option<String>,
    pub trigger_types: Vec<WebhookTrigger>,
    pub webhook_url: String,
    pub webhook_secret: Option<String>,
    pub notification_email_addresses: Vec<String>,
    pub privacy_mode: Option<PrivacyMode>,
}

A webhook configuration.

Webhooks send HTTP POST requests to your specified callback URL when events occur.

Example

let webhook = Webhook {
    id: WebhookId::new("webhook_123"),
    description: Some("Production webhook for message events".to_string()),
    trigger_types: vec![WebhookTrigger::MessageCreated, WebhookTrigger::MessageUpdated],
    webhook_url: "https://api.example.com/webhooks".to_string(),
    webhook_secret: Some("secret_key_xyz".to_string()),
    notification_email_addresses: vec!["admin@example.com".to_string()],
    privacy_mode: None,
};

Fields

id: WebhookId

Unique identifier for the webhook.

description: Option<String>

Description of the webhook.

trigger_types: Vec<WebhookTrigger>

List of trigger types this webhook listens for.

webhook_url: String

URL where webhook notifications will be sent.

webhook_secret: Option<String>

Secret key for webhook signature verification.

notification_email_addresses: Vec<String>

Email addresses to notify when webhook fails.

privacy_mode: Option<PrivacyMode>

Privacy mode settings (NEW in 2025)

When enabled, sensitive information is redacted from webhook payloads and server logs.

Trait Implementations

impl Clone for Webhook

fn clone(&self) -> Webhook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Webhook

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Webhook

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Webhook

impl PartialEq for Webhook

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

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 Webhook