Skip to content

Webhook Operations

Documentation for webhook configuration and events (coming soon).

Configuration

Configure webhook notifications to receive real-time alerts.

Example

typescript
const client = new XTwitterClient({
  webhook: {
    enabled: true,
    url: 'https://your-server.com/webhook',
    secret: 'your-secret-key',
    events: ['account_failure', 'api_rate_limit']
  }
});

Event Types

  • account_failure - Crawler account authentication failed
  • api_rate_limit - API rate limit exceeded
  • error - General error occurred
  • warning - Warning condition detected

Message Format

All webhook messages include:

  • type - Event type
  • severity - Message severity
  • timestamp - ISO 8601 timestamp
  • source - SDK component information
  • message - Human-readable message
  • details - Event-specific details
  • metadata - Additional context

See Webhook Notifications Guide for complete documentation.

Released under the MIT License.