Skip to main content

WebhookNotifier

Struct WebhookNotifier 

Source
pub struct WebhookNotifier { /* private fields */ }
Expand description

Builds outbound webhook payloads and signatures.

The notifier is stateless with respect to HTTP transport — it only builds the JSON body and HMAC-SHA256 signature. Callers are responsible for actually sending the HTTP POST (e.g. using reqwest or hyper).

Implementations§

Source§

impl WebhookNotifier

Source

pub fn new(config: WebhookConfig) -> Self

Create a new notifier with the given configuration.

Source

pub fn config(&self) -> &WebhookConfig

Returns a reference to the underlying configuration.

Source

pub fn build_payload( &self, event: &WebhookEvent, context: &WorkflowContext, ) -> String

Build the JSON payload string for the given event and context.

The payload is a JSON object with the following fields:

  • event_type: dot-separated event name (see WebhookEvent::event_type)
  • workflow_id: from context.workflow_id
  • workflow_name: from context.workflow_name
  • state: from context.state
  • timestamp_ms: Unix epoch in milliseconds
  • variables: from context.variables
  • step_name (optional): only present for step-level events
Source

pub fn compute_signature(&self, payload: &str) -> Option<String>

Compute HMAC-SHA256 of payload using the configured secret.

Returns None when no secret is configured, or Some(hex_string) (64 lowercase hex characters) when a secret is set.

Source

pub fn should_notify(&self, event: &WebhookEvent) -> bool

Returns true when the notifier is configured to send a notification for the given event.

Matching is done by event type string so that, for example, any StepCompleted { .. } event matches a StepCompleted { step_name: _ } entry.

Source

pub fn build_headers(&self, payload: &str) -> HashMap<String, String>

Build an HTTP headers map for a notification.

Always includes:

  • Content-Type: application/json

When a secret is configured, also includes:

  • X-Hub-Signature-256: <hex-digest>

Trait Implementations§

Source§

impl Clone for WebhookNotifier

Source§

fn clone(&self) -> WebhookNotifier

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WebhookNotifier

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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