Webhook Configuration
Webhook Configuration
Webhooks are configured through the Destinations system in the CMS. Each tenant can configure multiple webhook destinations with custom filtering and translation.
Configuration Schema
{
"tenant_id": "b79afb82-36b0-44f2-9102-494fa8e3c52f",
"name": "Production Analytics Webhook",
"destination_type": "webhook",
"config": {
"url": "https://api.example.com/webhooks/sports-stack",
"shared_secret": "your-secret-key-here",
"headers": {
"Authorization": "Bearer token123",
"X-Custom-Header": "value"
},
"timeout_ms": 5000
},
"streams": ["change_log"],
"entity_filters": ["event", "team", "player"],
"is_active": true,
"priority": 100
}Configuration Fields
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | HTTPS endpoint URL to receive webhooks |
shared_secret | string | No | Secret for HMAC-SHA256 signature verification |
headers | object | No | Custom HTTP headers to include in requests |
timeout_ms | integer | No | Request timeout in milliseconds (default: 5000) |
Setting Up via CMS
- Navigate to Integrations → Destinations in the CMS
- Click "New Destination"
- Select "Webhook" as the destination type
- Fill in configuration:
- Name: Descriptive name for the destination
- URL: Your HTTPS webhook endpoint
- Shared Secret: (Optional) Secret for signature verification
- Streams: Select
change_logstream - Entity Types: Filter which entities trigger webhooks (leave empty for all)
- Priority: Lower numbers = higher priority (default: 100)
Entity Filtering
Specify which entity types trigger webhooks using entity_filters:
{
"entity_filters": ["event", "team", "player"]
}Available Entity Types
teamplayereventleagueseasonsportmarketoddevent_scoped_statsseason_scoped_statsstandingsinjurynews
Note: Leave entity_filters empty to receive notifications for all entity types.
Testing Configuration
Use the built-in webhook tester to verify your configuration:
- Navigate to Admin → Webhook Tester in the CMS
- Select your tenant
- Copy the generated test URL
- Create a temporary destination using the test URL
- Trigger a data change
- Inspect the payload in the Webhook Tester interface
Related Documentation
- Webhooks Guide - Complete setup guide
- Webhook Payload Schema - Payload structure
- Destination System Usage - Configure destinations
Updated 29 days ago
