openzeppelin_monitor::services::notification

Struct WebhookNotifier

Source
pub struct WebhookNotifier {
    pub url: String,
    pub url_params: Option<HashMap<String, String>>,
    pub title: String,
    pub body_template: String,
    pub client: Client,
    pub method: Option<String>,
    pub secret: Option<String>,
    pub headers: Option<HashMap<String, String>>,
    pub payload_fields: Option<HashMap<String, Value>>,
}
Expand description

Implementation of webhook notifications via webhooks

Fields§

§url: String

Webhook URL for message delivery

§url_params: Option<HashMap<String, String>>

URL parameters to use for the webhook request

§title: String

Title to display in the message

§body_template: String

Message template with variable placeholders

§client: Client

HTTP client for webhook requests

§method: Option<String>

HTTP method to use for the webhook request

§secret: Option<String>

Secret to use for the webhook request

§headers: Option<HashMap<String, String>>

Headers to use for the webhook request

§payload_fields: Option<HashMap<String, Value>>

Payload fields to use for the webhook request

Implementations§

Source§

impl WebhookNotifier

Source

pub fn new(config: WebhookConfig) -> Result<Self, Box<NotificationError>>

Creates a new Webhook notifier instance

§Arguments
  • config - Webhook configuration
§Returns
  • Result<Self, Box<NotificationError>> - Notifier instance if config is valid
Source

pub fn format_message(&self, variables: &HashMap<String, String>) -> String

Formats a message by substituting variables in the template

§Arguments
  • variables - Map of variable names to values
§Returns
  • String - Formatted message with variables replaced
Source

pub fn from_config(config: &TriggerTypeConfig) -> Option<Self>

Creates a Webhook notifier from a trigger configuration

§Arguments
  • config - Trigger configuration containing Webhook parameters
§Returns
  • Option<Self> - Notifier instance if config is Webhook type
Source

pub fn sign_request( &self, secret: &str, payload: &WebhookMessage, ) -> Result<(String, String), Box<NotificationError>>

Trait Implementations§

Source§

impl Notifier for WebhookNotifier

Source§

fn notify<'life0, 'life1, 'async_trait>( &'life0 self, message: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a formatted message to Webhook

§Arguments
  • message - The formatted message to send
§Returns
  • Result<(), anyhow::Error> - Success or error
Source§

fn notify_with_payload<'life0, 'life1, 'async_trait>( &'life0 self, message: &'life1 str, payload_fields: HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a formatted message to Webhook with custom payload fields

§Arguments
  • message - The formatted message to send
  • payload_fields - Additional fields to include in the payload
§Returns
  • Result<(), anyhow::Error> - Success or error

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
§

impl<T> Chain<T> for T

§

fn len(&self) -> usize

The number of items that this chain link consists of.
§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
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
§

impl<T> ErasedDestructor for T
where T: 'static,