Pidge v3 API Reference

pip install pidge

from pidge import NotificationClient, NotificationConfig

config = NotificationConfig(
    api_key="your-api-key",
    endpoint="https://api.pidge.dev/v3",
)
async with NotificationClient(config=config) as client:
    result = await client.dispatch(msg)

from pidge import Message

msg = Message(
    to="customer@example.com",
    subject="Order Confirmed",
    body="Your order #ORD-1234 has been confirmed.",
    priority="normal",     # optional, default "normal"
    metadata={"order_id": "ord_abc123"},  # optional
)

from pidge import NotificationConfig

config = NotificationConfig(
    api_key="your-api-key",                # required
    endpoint="https://api.pidge.dev/v3",   # default
    timeout=30,                            # default
    retry_count=3,                         # default
)

from pidge import NotificationClient, NotificationConfig, Message, Status

config = NotificationConfig(api_key=os.environ["PIDGE_API_KEY"])

async with NotificationClient(config=config) as client:
    msg = Message(
        to=order.customer_email,
        subject=f"Order {order.order_id} Confirmed",
        body=f"Your order {order.order_id} has been confirmed.",
    )
    result = await client.dispatch(msg)
    notification_sent = result.status == Status.SENT

from pidge import DispatchError

try:
    result = await client.dispatch(msg)
except DispatchError as e:
    logger.error("dispatch_failed", code=e.code, message=e.message)