Skip to main content

WebhookConfig

Struct WebhookConfig 

Source
pub struct WebhookConfig {
    pub enabled: Option<bool>,
    pub url: Option<String>,
    pub secret: Option<String>,
    pub events: Option<Vec<WebhookEventSubscription>>,
    pub timeout_secs: Option<u32>,
    pub retry_count: Option<u32>,
    pub retry_backoff_ms: Option<u32>,
    pub queue_capacity: Option<u32>,
    pub parallel_queue_multiplier: Option<f32>,
    pub queue_policy: Option<WebhookQueuePolicy>,
}
Expand description

Webhook configuration for HTTP task event notifications.

Fields§

§enabled: Option<bool>

Enable webhook notifications (default: false).

§url: Option<String>

Webhook endpoint URL (required when enabled).

§secret: Option<String>

Secret key for HMAC-SHA256 signature generation. When set, webhooks include an X-Ralph-Signature header.

§events: Option<Vec<WebhookEventSubscription>>

Events to subscribe to (default: legacy task events only).

§timeout_secs: Option<u32>

Request timeout in seconds (default: 30, max: 300).

§retry_count: Option<u32>

Number of retry attempts for failed deliveries (default: 3, max: 10).

§retry_backoff_ms: Option<u32>

Retry backoff base in milliseconds (default: 1000, max: 30000).

§queue_capacity: Option<u32>

Maximum number of pending webhooks in the delivery queue (default: 500, range: 10-10000).

§parallel_queue_multiplier: Option<f32>

Multiplier for queue capacity in parallel mode (default: 2.0, range: 1.0-10.0). When running with N parallel workers, effective capacity = queue_capacity * max(1, workers * multiplier). Set higher (e.g., 3.0) if webhook endpoint is slow or unreliable.

§queue_policy: Option<WebhookQueuePolicy>

Backpressure policy when queue is full (default: drop_oldest).

  • drop_oldest: Drop new webhooks when full (preserves existing queue contents)
  • drop_new: Drop the new webhook if queue is full
  • block_with_timeout: Block sender briefly (100ms), then drop if still full

Implementations§

Source§

impl WebhookConfig

Source

pub fn merge_from(&mut self, other: Self)

Source

pub fn is_event_enabled(&self, event: &str) -> bool

Check if a specific event type is enabled.

Event filtering behavior:

  • If webhooks are disabled, no events are sent.
  • If events is None: only legacy task events are enabled (backward compatible).
  • If events is Some([...]): only those events are enabled; use ["*"] to enable all.

Trait Implementations§

Source§

impl Clone for WebhookConfig

Source§

fn clone(&self) -> WebhookConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WebhookConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WebhookConfig

Source§

fn default() -> WebhookConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for WebhookConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for WebhookConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for WebhookConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,