basalt / webhooks/src / WebhookDeliverer
Class: WebhookDeliverer
Defined in: webhooks/src/deliver.ts:233
POSTs signed JSON to an endpoint, retrying transient failures with backoff.
Constructors
Constructor
> new WebhookDeliverer(options?): WebhookDeliverer
Defined in: webhooks/src/deliver.ts:244
Parameters
options?
Returns
WebhookDeliverer
Accessors
allowedSchemes
Get Signature
> get allowedSchemes(): readonly string[]
Defined in: webhooks/src/deliver.ts:277
URL schemes this deliverer will send to (ssrf.allowedSchemes, default https: and http:). WebhookManager.register() refuses other schemes.
Returns
readonly string[]
hasDefaultSecret
Get Signature
> get hasDefaultSecret(): boolean
Defined in: webhooks/src/deliver.ts:292
True when a default (plugin-wide) signing secret is configured.
Returns
boolean
Methods
allowsPort()
> allowsPort(port): boolean
Defined in: webhooks/src/deliver.ts:286
True when this deliverer would send to port (the ssrf.allowedPorts policy; any port with ssrf: false). WebhookManager.register() refuses other ports.
Parameters
port
number
Returns
boolean
deliver()
> deliver(endpoint, event, data, options?): Promise<DeliveryResult>
Defined in: webhooks/src/deliver.ts:351
Parameters
endpoint
event
string
data
unknown
options?
DeliverOptions = {}
Returns
Promise<DeliveryResult>