Documentation menuAPI reference

API reference

Every export of @sweberdev/vector and @sweberdev/vector/postgres.

Sending: `@sweberdev/vector`

Returns a Vector. Options, all optional:

Option	Default
`store`	`new MemoryStore()`	Where data is kept
`retrySchedule`	`[5, 300, 1800, 7200, 18000, 36000, 36000]`	Seconds to wait after each failed attempt
`timeoutMs`	`15000`	Timeout per request
`maxResponseBytes`	`2048`	Response body stored per attempt
`maxPayloadBytes`	`262144`	Largest payload `send` accepts
`userAgent`	`Vector-Webhooks/1`
`urlPolicy`	`{}`	`{ allowPrivateNetworks?, allowHttp?, resolveHost? }`
`disableEndpointAfter`	`10`	Failed deliveries in a row before an endpoint is disabled; `0` never
`disableOnGone`	`true`	Disable endpoints that answer `410`
`secretRotationGraceSeconds`	`86400`	How long the old secret keeps signing
`envelope`	`true`	Body `{ type, timestamp, data }`; `false` sends the bare payload
`fetch`, `now`, `random`	globals	For tests
`onError`	`console.error`	Errors from listeners and the worker

Method	Returns
`create(input)`	`Endpoint`. Input: `url`, `tenant?`, `description?`, `eventTypes?`, `headers?`, `metadata?`, `secret?`, `enabled?`
`get(id, scope?)`	`Endpoint \| undefined`
`list(query?)`	`Endpoint[]`. Query: `tenant?`, `limit?`, `before?`
`update(id, input, scope?)`	`Endpoint \| undefined`. Input: `url?`, `description?`, `eventTypes?`, `headers?`, `metadata?`, `enabled?`
`delete(id, scope?)`	`boolean`
`rotateSecret(id, { tenant?, secret?, graceSeconds? })`	`Endpoint \| undefined`

scope is { tenant }; items of other tenants are treated as missing.

Method	Returns
`send({ eventType, payload, tenant?, idempotencyKey?, endpointIds?, deliverNow? })`	`{ message, deliveries, duplicate }`
`sendTest(endpointId, { tenant?, payload? })`	`Delivery \| undefined` after one attempt
`process({ limit?, concurrency? })`	`{ claimed, succeeded, retrying, failed, cancelled }`
`start({ intervalMs?, limit?, concurrency? })`	`{ stop(): Promise<void> }`
`retry(deliveryId, scope?)`	`Delivery \| undefined`
`resend(messageId, { tenant?, endpointId? })`	`Delivery[]`
`messages.get(id, scope?)`, `messages.list({ tenant?, eventType?, since?, before?, limit? })`
`deliveries.get(id, scope?)`, `deliveries.list({ tenant?, messageId?, endpointId?, status?, since?, before?, limit? })`
`attempts.list({ tenant?, deliveryId?, messageId?, endpointId?, since?, before?, limit? })`
`on(event, listener)`	unsubscribe function. Events: `attempt`, `delivery.succeeded`, `delivery.failed`, `endpoint.disabled`

Endpoint: id, tenant, url, description, secret, previousSecret, previousSecretExpiresAt, eventTypes, headers, metadata, enabled, disabledReason, failureStreak, createdAt, updatedAt
Message: id, tenant, eventType, payload, idempotencyKey, createdAt
Delivery: id, messageId, endpointId, tenant, eventType, status (pending, succeeded, failed, cancelled), attempts, nextAttemptAt, lockedUntil, lastAttemptAt, lastStatusCode, lastError, createdAt, updatedAt
Attempt: id, deliveryId, messageId, endpointId, tenant, at, durationMs, statusCode, success, error, responseBody
VectorStore: the storage interface; MemoryStore implements it

Export
`generateSecret(bytes = 24)`	New `whsec_` secret
`sign({ id, timestamp, payload, secret })`	`Promise<"v1,...">`
`signHeaders({ id, timestamp, payload, secret, secrets? })`	The three `webhook-*` headers; extra `secrets` add signatures
`verify(payload, headers, secret \| secrets, { toleranceSeconds?, now? })`	`Promise<{ id, timestamp, payload, raw }>` or throws `WebhookVerificationError`
`verifyRequest(request, secret \| secrets, options?)`	Same, for a Fetch API `Request`
`new Webhook(secret \| secrets, options?)`	`.verify(payload, headers)`, `.sign(id, timestamp, payload)`
`WebhookVerificationError`	`.code`: `missing_headers`, `invalid_timestamp`, `timestamp_too_old`, `timestamp_too_new`, `no_matching_signature`, `invalid_payload`
`HEADER_ID`, `HEADER_TIMESTAMP`, `HEADER_SIGNATURE`	Header names

Export
`assertDeliverableUrl(url, policy?)`	Resolves to a `URL` or throws `UrlNotAllowedError`
`isPrivateAddress(ip)`	`true` for loopback, private, link-local and reserved addresses

matchesEventType(filter, eventType) and endpointWants(filters, eventType) implement the filter rules (invoice.paid, invoice.*, *).

Export
`createPostgresStore({ query, tablePrefix? })`	`PostgresStore` with `migrate()`
`postgresSchema(tablePrefix?)`	The `create table` SQL
`PostgresQuery`	`(text, params) => Promise<{ rows }>`