Hookdeck Data Export Templates

This repository contains pre-built dashboard templates for visualizing Hookdeck metrics in popular observability platforms. These templates help you quickly set up comprehensive monitoring dashboards for your webhook infrastructure.

📚 For complete details about Hookdeck metrics, including available metrics and export features, see the Hookdeck Metrics Documentation.

Available Templates

Datadog Template

File: datadog/template.json

A comprehensive Datadog dashboard template with pre-configured panels for:

• Request metrics (total, accepted, rejected)
• Event processing (successful, failed, ignored)
• Delivery attempts and failure rates
• Queue monitoring (pending events, oldest message age)
• Performance metrics (response latency)
• Resource breakdowns (requests per source, attempts per destination)

Prometheus/Grafana Template

File: prometheus/template.json

A Grafana dashboard template designed for Prometheus data sources with panels for:

• Source request rates and statuses
• Event processing metrics
• Delivery attempt monitoring
• Queue depth by destination
• Response latency averages

New Relic Template

File: new-relic/template.json

A New Relic dashboard template with comprehensive monitoring panels including:

• Request metrics (total, accepted, rejected)
• Event processing (total, successful, failed)
• Delivery attempts (total, delivered, failed)
• Queue monitoring (queued messages, oldest message age)
• Performance metrics (response latency, error rate, average attempts per event)
• Resource breakdowns (requests per source, attempts per destination)

Quick Start

Datadog Setup

1. Enable Integration: Follow the Datadog export setup instructions
2. Import Template:
   • Download datadog/template.json
   • In Datadog, go to Dashboards → New Dashboard → Import dashboard JSON
   • Upload the template file

Prometheus Setup

1. Enable Integration: Follow the Prometheus export setup instructions
2. Configure Scraping: Add this job to your prometheus.yml:

   scrape_configs:
     - job_name: "hookdeck"
       scrape_interval: 30s
       metrics_path: "/metrics/prometheus"
       scheme: https
       bearer_token: "YOUR_HOOKDECK_API_KEY"
       static_configs:
         - targets: ["api.hookdeck.com"]

3. Import Template:
   • Download prometheus/template.json
   • In Grafana: Dashboards → New → Import
   • Upload the JSON file and select your Prometheus data source

New Relic Setup

1. Enable Integration: Follow the New Relic export setup instructions
2. Import Template:
   • Download new-relic/template.json
   • In New Relic, go to Dashboards → Import dashboard
   • Upload the template file
   • Replace YOUR_ACCOUNT_ID in the queries with your actual New Relic account ID

Template Details

All templates provide comprehensive monitoring for your webhook infrastructure with metrics including:

• Request Tracking: Monitor total, accepted, and rejected requests
• Event Processing: Track event success, failures, and processing rates
• Delivery Attempts: View attempt counts, success rates, and failures
• Queue Monitoring: Track pending events and message age (Datadog and New Relic)
• Performance Metrics: Observe response latencies and error rates
• Resource Breakdowns: View metrics by sources, connections, and destinations

For detailed information about each metric, see the metrics documentation.

Customization

These templates serve as starting points and can be customized for your specific needs:

• Filter by Resources: Modify queries to focus on specific sources or destinations
• Adjust Time Ranges: Change aggregation periods and display windows
• Add Alerts: Set up notifications based on thresholds
• Create Variables: Add dynamic filtering capabilities

Troubleshooting

Data not appearing?

• Verify the integration is enabled in your project settings
• Check that your API key has proper permissions
• Ensure metrics are flowing by testing the integration

Need help?

• 💬 Contact us via live chat in the Hookdeck dashboard
• 📧 Email us at info@hookdeck.com
• 📚 Review the full metrics documentation

Contributing

To suggest improvements or report issues with these templates, please open an issue in this repository.