Skip to content

README.md

Latest commit

 

History

History
195 lines (141 loc) · 5.4 KB

README.md

File metadata and controls

195 lines (141 loc) · 5.4 KB

Slack-to-Glue Webhook Service

A Python web application that accepts HTTP POST requests to /services/<ID> endpoints, processes them according to YAML configuration, and forwards them to configured Glue.ai endpoints.

Features

  • RESTful API endpoint for webhook processing
  • YAML-based configuration mapping service IDs to Glue configurations
  • Docker containerization for easy deployment
  • DevContainer support for development
  • Automated CI/CD pipeline with GitHub Actions
  • Health check endpoint for monitoring
  • Structured logging and error handling

Quick Start

Development with DevContainer

  1. Open the project in VS Code
  2. Click "Reopen in Container" when prompted
  3. The development environment will be set up automatically
  4. Run the application: python app.py

Local Development

# Install dependencies
pip install -r requirements.txt

# Run the application with default config (config.yml)
python app.py

# Run with a different config file (e.g., for development)
CONFIG_FILE=dev-config.yml python app.py

# Run with debug mode and custom config
DEBUG=true CONFIG_FILE=dev-config.yml python app.py

The service will be available at http://localhost:8080

Docker Deployment

Using Docker Compose (Recommended)

# Start the service (builds image if needed)
docker compose up -d

# View logs
docker compose logs -f

# Stop the service
docker compose down

# Rebuild after code changes
docker compose up -d --build

To customize the configuration:

  1. Copy config.yml-example to config.yml
  2. Edit config.yml with your service configurations
  3. The compose file automatically mounts config.yml into the container
  4. Restart the service: docker compose restart

For development with a separate config:

  1. Uncomment the dev-config.yml volume mount in docker-compose.yml
  2. Set CONFIG_FILE=dev-config.yml in the environment section
  3. Restart: docker compose up -d

Using Docker CLI

# Build the image
docker build -t slack-to-glue-webhook .

# Run the container (you must mount your config.yml file)
docker run -p 8080:8080 \
  -v /path/to/your/config.yml:/app/config.yml \
  slack-to-glue-webhook

# Or run with a custom config file name
docker run -p 8080:8080 \
  -v /path/to/your/dev-config.yml:/app/dev-config.yml \
  -e CONFIG_FILE=dev-config.yml \
  slack-to-glue-webhook

Note: The Docker image does not include config.yml - you must mount your own config file at runtime. An example configuration is included as config.yml-example in the container for reference.

API Endpoints

POST /services/<service_id>

Processes a webhook for the specified service ID.

Request:

  • Content-Type: application/json
  • Body: JSON payload from the source webhook

Response:

{
  "status": "success|warning|error",
  "message": "Description of the result",
  "response_code": 200
}

GET /health

Health check endpoint for monitoring.

Response:

{
  "status": "healthy",
  "service": "slack-to-glue-webhook"
}

Configuration

The service uses a YAML configuration file (config.yml) to map service IDs to their corresponding Glue configurations:

services:
  example-service:
    target: "grp_xxxxxxxxxxxxxxxxxxxxx"  # Glue group/thread ID
    webhook_url: "https://api.gluegroups.com/webhook/wbh_xxxxx/xxxxx"
    description: "Example service for testing"

# Global configuration (optional)
global:
  timeout_seconds: 30
  retry_attempts: 3
  log_level: "INFO"

Configuration Fields

Service Configuration:

  • target: The Glue.ai group or thread identifier (e.g., grp_xxxxxxxxxxxxxxxxxxxxx)
  • webhook_url: The Glue webhook endpoint URL to forward processed webhooks
  • description: Optional description of the service

Global Configuration (optional):

  • timeout_seconds: Request timeout in seconds (default: 30)
  • retry_attempts: Number of retry attempts for failed requests (default: 3)
  • log_level: Logging level - INFO, DEBUG, WARNING, ERROR (default: INFO)

Environment Variables

  • PORT: Server port (default: 8080)
  • DEBUG: Enable debug mode (default: false)
  • CONFIG_FILE: Path to configuration file (default: config.yml)

Deployment

GitHub Container Registry

The project includes a GitHub Actions workflow that automatically builds and publishes Docker images to GitHub Container Registry on pushes to main/master branches.

Manual Deployment

  1. Build the Docker image: docker build -t slack-to-glue-webhook .
  2. Push to your registry: docker push your-registry/slack-to-glue-webhook
  3. Deploy using your preferred container orchestration platform

Development

Project Structure

├── app.py                    # Main Flask application
├── config.yml               # Service configuration
├── config.yml-example       # Example configuration file
├── requirements.txt         # Python dependencies
├── Dockerfile              # Docker build configuration
├── docker-compose.yml      # Docker Compose configuration
├── .devcontainer/          # VS Code DevContainer setup
│   └── devcontainer.json
└── .github/workflows/      # CI/CD pipeline
    └── docker-build-deploy.yml

Adding New Services

  1. Add a new entry to config.yml under the services section
  2. Restart the application to load the new configuration
  3. Send POST requests to /services/<your-new-service-id>

License

See LICENSE file for details.