Skip to main content

webhooks

webhooks — ɳSelf documentation.

Webhooks Plugin

Outbound webhook dispatcher with retry, HMAC signing, and dead-letter queue. Free: MIT licensed.

Install

nself plugin install webhooks

What It Does

Delivers outbound HTTP webhooks to external URLs based on Hasura event triggers. Signs payloads with HMAC-SHA256 for verification. Handles retries with exponential backoff, maintains a dead-letter queue for failed deliveries, and logs all attempts.

Configuration

Env VarDefaultDescription
WEBHOOKS_PORT3060Webhooks service port
WEBHOOKS_SECRETnoneDefault HMAC signing secret
WEBHOOKS_MAX_RETRIES5Max delivery attempts
WEBHOOKS_TIMEOUT30sHTTP delivery timeout

Ports

PortPurpose
3060Webhooks service REST API

Database Tables

2 tables added to your Postgres database:

  • np_webhooks_endpoints: registered webhook destinations
  • np_webhooks_deliveries: delivery log and dead-letter queue

Nginx Routes

None, webhooks service is internal only.

API

GET  /health: Health check
GET  /endpoints: List webhook endpoints
POST /endpoints: Register an endpoint
DELETE /endpoints/{id}: Remove endpoint
POST /deliver: Trigger manual delivery
GET  /deliveries: Delivery history
GET  /deliveries/failed: Dead-letter queue
POST /deliveries/{id}/retry: Retry failed delivery