Webhooks Plugin

Outbound webhook delivery for your nSelf-powered app. Let users register endpoint URLs and receive real-time HTTP callbacks whenever events occur in your system — the building block for third-party integrations.

Overview

• Endpoint Registration — users register webhook URLs with event type subscriptions
• HMAC Signatures — every delivery is signed with a per-endpoint secret
• Retry with Backoff — failed deliveries retry up to 5 times with exponential backoff
• Delivery Log — full request/response log per delivery attempt
• Event Filtering — subscribe to specific event types (e.g., user.created, payment.completed)
• Replay — replay any delivery from the last 30 days

Installation

nself plugin install webhooks

nself plugin status webhooks

Register a Webhook (API)

POST /api/webhooks
{
  "url": "https://your-service.com/webhooks/nself",
  "events": ["user.created", "payment.completed"],
  "description": "My integration"
}

# Returns:
{
  "id": "wh_abc123",
  "secret": "whsec_xxxxxxxx",
  "created_at": "..."
}

Verify a Delivery

// Verify the HMAC signature on incoming webhooks
const signature = req.headers['x-nself-signature']
const expected = crypto
  .createHmac('sha256', webhookSecret)
  .update(rawBody)
  .digest('hex')

if (signature !== `sha256=${expected}`) {
  return res.status(401).send('Invalid signature')
}