Skip to navigation
BookingExperience Booking APImanagement

Control Stripe Webhook Consumer

🎛️ Stripe Webhook Consumer Control

Control the lifecycle of the Stripe webhook consumer service.

🔧 Available Actions

Start Consumer

  • Initializes and starts the consumer service
  • Begins processing Stripe webhook events
  • Activates health monitoring

Stop Consumer

  • Gracefully stops the consumer service
  • Disconnects from Kafka
  • Stops health monitoring

Restart Consumer

  • Stops and then restarts the consumer
  • Useful for recovery from errors
  • Maintains service availability

🎯 Use Cases

  • Service Management: Start/stop consumer during maintenance
  • Error Recovery: Restart consumer after failures
  • Testing: Control consumer state for testing scenarios
  • Deployment: Manage consumer during deployments

⚠️ Important Notes

  • Start: Only works if consumer is not already running
  • Stop: Gracefully shuts down active connections
  • Restart: Automatically handles stop/start sequence
  • Health Monitoring: Automatically restarts failed consumers

Authentication

AuthorizationBearer

JWT token from @etera-ai/auth package (auth.etera.dev) - Format: Bearer <token>

Request

This endpoint expects an object.
action"start" or "stop" or "restart"Required
Action to perform on the consumer

Response

Consumer control action completed successfully
successbooleanOptional
actionstringOptional
resultobjectOptional
timestampdatetimeOptional

Errors

400
Bad Request Error