Elk

Webhooks

Webhook event delivery and subscription management for the Elk API. Configure application triggers and handle asynchronous events in your workflows.

Developers → API Docs → Webhooks
Intro Tutorials Reference Webhooks Support

Webhook Overview

Webhooks let you receive asynchronous event notifications from Elk's API. You can register endpoints to be called when specific events happen in your application or integration.

Events Supported

  • deployment_created - Triggered when a deployment starts
  • build_failed - Triggered when a build fails
  • deployment_succeeded - Deployment was successful

Security

  • Each webhook includes X-Elk-Signature headers for verification
  • Requires TLS 1.2+ for event delivery
  • Event rate limiting: 500 events/minute per webhook

Creating a Webhook

Using the API

POST /webhooks
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "topic": "deployment_created",
  "callback_url": "https://your-app.com/webhooks",
  "secret": "your-128-bit-secret"
}

Webhook Delivery

Events are delivered with these common headers:

Header Description
X-Elk-Id Unique identifier for this event
X-Elk-Delivered Timestamp of when event was sent
X-Elk-Signature HMAC-SHA256 signature

Example Implementation

Node.js Example

const express = require('express');
const crypto = require('crypto');

const app = express();
const SECRET = 'your-128-bit-secret';

app.post('/webhooks', (req, res) => {
    const headerSig = req.headers['x-elk-signature'];
    const computedSig = crypto.createHmac('sha256', SECRET)
                  .update(JSON.stringify(req.body))
                  .digest('hex');
    
    if (headerSig !== computedSig) {
        return res.status(401).send('Invalid signature');
    }

    // Process the event
    console.log('Received event:', req.body);

    res.status(200).send('OK');
});

Troubleshooting

Related API Guides

Deployment Events

See all webhooks specific to deployment events including rollbacks and status updates

View Guide →

Security

Learn how to verify and confirm your webhook signatures for production systems

View Guide →

Start Using Webhooks

Create powerful automation and real-time integrations by receiving event notifications from Elk.

Create First Webhook