API Docs
Webhooks
API ReferenceWebhooksSetup

Webhook Setup

Configure webhook endpoints to receive event notifications.

Step 1: Add Your Endpoint

Navigate to your Uprails dashboard and add your webhook endpoint URL under Settings → Webhooks.

Your endpoint must:

  • Accept POST requests
  • Return a 200 status code within 30 seconds
  • Be publicly accessible (or use a tunnel for local development)

Step 2: Select Events

Choose which events you want to receive. You can subscribe to specific events or all events.

Step 3: Test Your Endpoint

Use the dashboard's webhook testing feature to send a test event to your endpoint and verify it's working correctly.

Local Development

For local development, use a tunnel service to expose your local server:

# Using ngrok
ngrok http 3000

# Using cloudflared
cloudflared tunnel --url http://localhost:3000

Then add the tunnel URL as your webhook endpoint in the dashboard.

Retry Policy

If your endpoint doesn't respond with a 200 status code, Uprails retries delivery with exponential backoff:

AttemptDelay
1st retry5 minutes
2nd retry30 minutes
3rd retry2 hours
4th retry8 hours
5th retry24 hours

After 5 failed attempts, the event is marked as failed and no further retries are made.