Fairlx Logo

Beta

Webhooks

Receive HTTP callbacks when events occur in your Fairlx workspace.

Overview

Webhooks allow you to receive HTTP POST requests when specific events occur:

  • Integrate with external systems
  • Trigger automations
  • Sync data with other tools

Setting Up Webhooks

  1. Open the project and go to Settings → Webhooks
  2. Click "Add Webhook"
  3. Enter a name and your endpoint URL
  4. Select the events to send
  5. Add a secret if you want signed requests, then save. Use Ping / Test Webhook to send a test event.

Webhook Payload

Each webhook request includes:

Webhook Payload Example
{
  "event": "STATUS_CHANGED",
  "projectId": "proj_xyz789",
  "timestamp": "2024-01-15T10:30:00Z",
  "content": "[Mobile App] Status Changed: Fix login bug",
  "project": {
    "id": "proj_xyz789",
    "name": "Mobile App",
    "imageUrl": "https://..."
  },
  "actor": {
    "userId": "user_456",
    "userName": "Jane Doe",
    "userEmail": "[email protected]"
  },
  "data": {
    "workitemId": "wi_123",
    "workitemKey": "MOB-12",
    "title": "Fix login bug",
    "summary": "...",
    "deepLinkUrl": "https://app.fairlx.com/..."
  },
  "embeds": [...]
}

Security

Each request carries X-Fairlx-Event and X-Fairlx-Delivery headers. When the webhook has a secret, X-Fairlx-Signature holds the hex HMAC-SHA256 of the raw body. Compute it with your secret and reject requests that do not match. Without a secret, requests are not signed.

Warning

Always verify webhook signatures in production to prevent spoofing.