Configure Webhook

Webhook Configuration: Set up comprehensive webhook URL and event subscriptions with advanced security and delivery options.

Event Types:

• job.completed - Job finished successfully with download URL
• job.failed - Job encountered an error with detailed failure information
• job.cancelled - Job was manually cancelled or timed out
• job.progress - Periodic progress updates during execution (optional)

Advanced Configuration Example:

 
{
  "webhook_url": "https://your-api.com/webhooks/cipherstream",
  "events": ["job.completed", "job.failed"],
  "enabled": true,
  "secret": "your-webhook-secret-key",
  "custom_headers": {
    "X-API-Version": "v1",
    "X-Client-ID": "your-client-id"
  },
  "retry_config": {
    "max_attempts": 3,
    "backoff_multiplier": 2,
    "initial_delay_seconds": 1
  },
  "timeout_seconds": 30,
  "batch_delivery": false,
  "ip_whitelist": ["203.0.113.0/24"]
}

Security Requirements:

• HTTPS only: Webhook URLs must use HTTPS protocol
• Valid SSL certificate: Endpoint must have valid SSL/TLS certificate
• Response requirements: Endpoint must return HTTP 2xx status codes
• Signature verification: Implement HMAC-SHA256 signature validation
• Timestamp validation: Check webhook timestamp to prevent replay attacks

Response Validation: Your webhook endpoint should:

1. Return HTTP status 200-299 for successful processing
2. Respond within the configured timeout period
3. Validate the HMAC signature if secret is configured
4. Handle duplicate deliveries gracefully (idempotent processing)
5. Log webhook deliveries for debugging and monitoring

Error Handling:

• 4xx responses: Webhook delivery will not be retried
• 5xx responses: Webhook will be retried according to retry configuration
• Timeout: Request timeout will trigger retry attempts
• Connection errors: Network failures will trigger retry attempts
• SSL errors: Certificate validation failures will not be retried

Use Cases:

• Real-time job completion notifications
• Automated data pipeline triggers
• System integration and workflow automation
• Monitoring and alerting systems
• Business process automation
• Customer notification systems