Skip to main content

Email Notifications

Configure email notifications for document processing events and system alerts.

Email Service Configuration

bash
# Environment Variables
ARTOS_EMAIL_SERVICE=sendgrid  # or aws_ses, mailgun
ARTOS_EMAIL_API_KEY=your_sendgrid_api_key
[email protected]
ARTOS_EMAIL_FROM_NAME="Artos Document Platform"
yaml
# Configuration File
notifications:
  email:
    service: sendgrid
    api_key: your_sendgrid_api_key
    from_address: [email protected]
    from_name: "Artos Document Platform"
    templates:
      document_complete: template_id_123
      pipeline_complete: template_id_456
      error_alert: template_id_789

Email Notification Setup

python
# Configure email notifications
client.notifications.configure_email(
    service="sendgrid",
    api_key="your_api_key",
    from_address="[email protected]"
)

# Subscribe to notifications
client.notifications.subscribe(
    email="[email protected]",
    events=["document_complete", "pipeline_complete", "error_alert"]
)

# Configure per-event notifications
client.notifications.configure_events({
    "document_complete": {
        "enabled": True,
        "email_template": "doc_complete",
        "recipients": ["[email protected]"]
    },
    "pipeline_complete": {
        "enabled": True,
        "email_template": "pipeline_complete", 
        "recipients": ["[email protected]"]
    },
    "error_alert": {
        "enabled": True,
        "email_template": "error_alert",
        "recipients": ["[email protected]"]
    }
})

Supported Email Services

SendGrid
python
client.notifications.configure_email(
    service="sendgrid",
    api_key="SG.your_api_key",
    from_address="[email protected]"
)
AWS SES
python
client.notifications.configure_email(
    service="aws_ses",
    aws_access_key="AKIA...",
    aws_secret_key="secret_key",
    aws_region="us-east-1",
    from_address="[email protected]"
)