Webhooks

Webhooks allow your external systems to receive real-time notifications when events occur in your NuxtBase organization.

Setting Up a Webhook

1. Navigate to Webhooks in the sidebar
2. Click Create Webhook
3. Enter the endpoint URL where you want to receive events
4. Select which events to subscribe to
5. Save the webhook

How It Works

When a subscribed event occurs:

1. NuxtBase sends an HTTP POST request to your endpoint URL
2. The request body contains the event type and relevant data in JSON format
3. Your server processes the event and returns a 2xx status code
4. If delivery fails, NuxtBase will retry the request

Delivery Tracking

Each webhook endpoint shows:

• Delivery history — A log of all sent events
• Status — Whether each delivery succeeded or failed
• Response code — The HTTP status code returned by your server
• Timestamp — When the delivery was attempted

Managing Webhooks

Editing a Webhook

Update the endpoint URL or change which events you're subscribed to at any time.

Disabling a Webhook

Temporarily disable a webhook without deleting it. Disabled webhooks stop receiving events but retain their configuration.

Deleting a Webhook

Remove a webhook endpoint permanently. Pending deliveries to the deleted endpoint will be canceled.

Best Practices

• Use HTTPS — Always use HTTPS endpoints for secure data transmission
• Respond quickly — Return a 2xx response within a few seconds to acknowledge receipt
• Process asynchronously — Queue received events for background processing rather than handling them in the request
• Verify payloads — Validate incoming webhook payloads to ensure they originate from NuxtBase