Auth0EventStream - Technical Documentation

This document provides comprehensive technical documentation for the Auth0EventStream deployment component.

Architecture Overview

flowchart TB
    subgraph Auth0["Auth0 Tenant"]
        Events["Auth0 Events"]
        ES["Event Stream"]
    end
    
    subgraph Destinations["Destinations"]
        EB["AWS EventBridge"]
        WH["Webhook Endpoint"]
    end
    
    subgraph AWS["AWS Infrastructure"]
        Bus["Event Bus"]
        Rules["Event Rules"]
        Lambda["Lambda"]
        SQS["SQS Queue"]
    end
    
    subgraph Webhook["Custom Endpoint"]
        API["HTTPS API"]
        Worker["Event Worker"]
    end
    
    Events --> ES
    ES -->|EventBridge| EB
    ES -->|Webhook| WH
    EB --> Bus --> Rules
    Rules --> Lambda
    Rules --> SQS
    WH --> API --> Worker

Resource Model

Auth0EventStream

The Auth0EventStream resource follows the Kubernetes Resource Model (KRM) pattern:

apiVersion: auth0.openmcf.org/v1
kind: Auth0EventStream
metadata:
  name: <string>          # Required: unique identifier
  org: <string>           # Organization that owns this resource
  env: <string>           # Environment (production, staging, etc.)
  labels: <map>           # Key-value pairs for filtering
spec:
  destination_type: <string>               # Required: eventbridge | webhook
  subscriptions: <list[string]>            # Required: event types to subscribe
  eventbridge_configuration: <object>      # For EventBridge destination
  webhook_configuration: <object>          # For Webhook destination
status:
  outputs:
    id: <string>                           # Event stream ID (est_XXXX)
    name: <string>                         # Stream name
    status: <string>                       # active | suspended | disabled
    destination_type: <string>             # eventbridge | webhook
    subscriptions: <list[string]>          # Subscribed event types
    created_at: <string>                   # ISO 8601 timestamp
    updated_at: <string>                   # ISO 8601 timestamp
    aws_partner_event_source: <string>     # For EventBridge only

Specification Details

Destination Types

EventBridge Configuration

message Auth0EventBridgeConfiguration {
  // AWS account ID (12-digit number)
  string aws_account_id = 1;
  
  // AWS region (e.g., us-east-1)
  string aws_region = 2;
}

Validation Rules:

• aws_account_id: Must be exactly 12 digits
• aws_region: Required, non-empty string

Immutability: EventBridge configuration cannot be changed after creation. Any modification requires deleting and recreating the event stream.

Webhook Configuration

message Auth0WebhookConfiguration {
  // HTTPS endpoint URL
  string webhook_endpoint = 1;
  
  // Authorization settings
  Auth0WebhookAuthorization webhook_authorization = 2;
}

message Auth0WebhookAuthorization {
  // Authorization method: basic | bearer
  string method = 1;
  
  // For basic auth
  string username = 2;
  string password = 3;
  
  // For bearer token
  string token = 4;
}

Validation Rules:

• webhook_endpoint: Must start with https://
• method: Must be basic or bearer
• webhook_authorization: Required

Subscriptions

Subscriptions define which event types the stream receives. At least one subscription is required.

Common Event Categories:

IaC Implementation

Pulumi Module

The Pulumi module is implemented in Go:

iac/pulumi/
├── main.go              # Entry point, loads stack input
├── Pulumi.yaml          # Pulumi project configuration
├── Makefile             # Build and test targets
├── debug.sh             # Local debugging script
└── module/
    ├── main.go          # Provider setup, orchestration
    ├── locals.go        # Input processing
    ├── eventstream.go   # Event stream creation
    └── outputs.go       # Stack output exports

Key Implementation Details:

1. Provider Configuration: Uses auth0.NewProvider with credentials from stack input or environment variables
2. Resource Creation: Uses auth0.NewEventStream with configuration based on destination type
3. Outputs: Exports ID, name, status, and destination-specific information

Terraform Module

The Terraform module uses HCL:

iac/tf/
├── provider.tf    # Auth0 provider configuration
├── variables.tf   # Input variable definitions
├── locals.tf      # Computed values
├── main.tf        # Event stream resource
└── outputs.tf     # Output definitions

Key Implementation Details:

1. Dynamic Blocks: Uses dynamic blocks to conditionally include EventBridge or Webhook configuration
2. Conditional Logic: Applies configuration based on destination_type
3. Sensitive Data: Passwords and tokens marked as sensitive

Event Delivery

EventBridge Flow

sequenceDiagram
    participant Auth0
    participant EventStream
    participant EventBridge
    participant EventBus
    participant Lambda
    
    Auth0->>EventStream: Event occurs
    EventStream->>EventBridge: Publish to partner source
    EventBridge->>EventBus: Route to event bus
    EventBus->>Lambda: Trigger via rule

Setup Steps After Deployment:

1. Get the aws_partner_event_source from stack outputs
2. Associate the partner event source with an EventBridge event bus
3. Create rules on the event bus to route events
4. Configure targets (Lambda, SQS, SNS, etc.)

Webhook Flow

sequenceDiagram
    participant Auth0
    participant EventStream
    participant Webhook
    participant App
    
    Auth0->>EventStream: Event occurs
    EventStream->>Webhook: POST event payload
    Note over EventStream,Webhook: Include Authorization header
    Webhook->>App: Process event
    App->>Webhook: 200 OK
    Webhook->>EventStream: Acknowledge

Webhook Requirements:

• Protocol: HTTPS only (HTTP not supported)
• Response Time: Must respond within 10 seconds
• Success Codes: 2xx status codes indicate success
• Retries: Auth0 retries failed deliveries with exponential backoff

Security Considerations

Credential Management

• Store Auth0 credentials securely (not in source control)
• Use environment variables or secret management systems
• Rotate M2M application credentials regularly

Webhook Security

• Always use HTTPS endpoints
• Verify webhook signatures when possible
• Rotate bearer tokens and passwords periodically
• Use strong, unique credentials for each environment

EventBridge Security

• Follow AWS IAM best practices
• Use least-privilege permissions for event bus access
• Enable encryption for event data in transit

Troubleshooting

Common Issues

Debugging

1. Check stream status: Should be "active"
2. Verify subscriptions: Ensure correct event types
3. Test webhook endpoint: Confirm HTTPS accessibility
4. Review Auth0 logs: Check for delivery errors

Performance

Event Delivery

• Latency: Near real-time (typically < 5 seconds)
• Throughput: Scales with Auth0 tenant limits
• Ordering: Events may arrive out of order

Best Practices

1. Minimize subscriptions: Only subscribe to needed events
2. Fast webhook response: Return 200 quickly, process asynchronously
3. Idempotent processing: Handle duplicate events gracefully
4. Monitor delivery: Track success/failure rates

Comparison: EventBridge vs Webhook

References

• Auth0 Event Streams Documentation
• Auth0 Event Types Reference
• AWS EventBridge Partner Event Sources
• Terraform auth0_event_stream
• Pulumi Auth0 EventStream