Skip to main content

ForgeWebhook

Trait ForgeWebhook 

Source
pub trait ForgeWebhook:
    Send
    + Sync
    + 'static {
    // Required methods
    fn info() -> WebhookInfo;
    fn execute(
        ctx: &WebhookContext,
        payload: Value,
    ) -> Pin<Box<dyn Future<Output = Result<WebhookResult>> + Send + '_>>;
}
Expand description

Trait for FORGE webhook handlers.

Webhooks are HTTP endpoints that receive external events (e.g., from Stripe, GitHub). They support signature validation, idempotency, and bypass authentication.

Required Methods§

Source

fn info() -> WebhookInfo

Get webhook metadata.

Source

fn execute( ctx: &WebhookContext, payload: Value, ) -> Pin<Box<dyn Future<Output = Result<WebhookResult>> + Send + '_>>

Execute the webhook handler.

§Arguments
  • ctx - Webhook context with db, http, and dispatch capabilities
  • payload - The raw JSON payload from the request body

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§