Struct WebhookSourceConfig 

pub struct WebhookSourceConfig {
    pub listen_addr: String,
    pub path: String,
    pub max_payloads: Option<usize>,
    pub timeout_secs: u64,
    pub max_body_bytes: usize,
    pub auth_token: Option<String>,
    pub batch_size: usize,
}

Available on crate features source-rest and source-webhook only.

Configuration for the webhook receiver source.

Fields

listen_addr: String

Address to bind the HTTP server to (default: "127.0.0.1:8080").

Security: the default binds to loopback only. Binding to 0.0.0.0 exposes the receiver to the whole network — only do so behind a trusted gateway, and set auth_token to require a shared secret on every request.

path: String

Endpoint path for receiving webhooks (default: "/webhook").

max_payloads: Option<usize>

Stop after receiving this many payloads.

timeout_secs: u64

How long to listen before returning, in seconds (default: 30).

max_body_bytes: usize

Maximum accepted request body size in bytes (default: 1 MiB). Larger POSTs are rejected with 413 Payload Too Large so a single huge request can’t exhaust memory.

auth_token: Option<String>

Optional shared secret. When set, every request must carry it in the Authorization header (either the raw token or Bearer <token>); requests without it are rejected with 401 Unauthorized. When None (default) the endpoint is unauthenticated.

batch_size: usize

Records per emitted StreamPage. The webhook source has no native streaming primitive — it accumulates incoming POSTs into an in-memory buffer during the receive window, then the default Source::stream_pages impl chunks that buffer into pages of this size. Defaults to DEFAULT_BATCH_SIZE.

batch_size = 0 is the “no batching” sentinel: the entire flush window is emitted in a single page. For this source it is functionally equivalent to any positive value larger than the received payload count — the server-side buffering behaviour does not change.

Implementations

impl WebhookSourceConfig

pub fn new() -> WebhookSourceConfig

Create a new config with sensible defaults.

pub fn listen_addr(self, addr: impl Into<String>) -> WebhookSourceConfig

Set the listen address.

pub fn path(self, path: impl Into<String>) -> WebhookSourceConfig

Set the webhook endpoint path.

pub fn max_payloads(self, max: usize) -> WebhookSourceConfig

Stop after receiving this many payloads.

pub fn timeout_secs(self, secs: u64) -> WebhookSourceConfig

Set the timeout in seconds.

pub fn max_body_bytes(self, bytes: usize) -> WebhookSourceConfig

Set the maximum accepted request body size in bytes.

pub fn auth_token(self, token: impl Into<String>) -> WebhookSourceConfig

Require a shared-secret token in the Authorization header.

pub fn with_batch_size(self, batch_size: usize) -> WebhookSourceConfig

Set the per-page record count for Source::stream_pages.

Pass 0 to opt out of batching — the entire flush window is emitted in a single StreamPage. The webhook source’s server-side buffering is unaffected; only the downstream chunking changes.

Trait Implementations

impl Clone for WebhookSourceConfig

fn clone(&self) -> WebhookSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookSourceConfig

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

Formats the value using the given formatter.

impl Default for WebhookSourceConfig

fn default() -> WebhookSourceConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebhookSourceConfig

where WebhookSourceConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WebhookSourceConfig

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

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.

impl Serialize for WebhookSourceConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.