eCardWidget Developer Documentation

Build with eCardWidget. Send branded eCards over email or share-link, sync your directory from any HR system, subscribe to member-change webhooks, and ship integrations with Zapier — all from one consolidated API.

Quickstart

Authentication & basics

Get your API key, learn the base URL, response shapes, and rate limits.

Dashboard

Developer Portal

Generate API keys, browse the API reference, and configure webhooks from Settings → Developers.

Send an eCard

Send via email or generate a copy-paste share link with custom branding.

Integration

Directory Sync

Upsert team members from your HR or CRM system. PATCH semantics, email/employee_id matching.

Real-time

Webhooks

Subscribe to member-change events with HMAC-signed payloads. React to deltas without polling.

Reference

API Reference

Interactive OpenAPI reference with every endpoint, request samples in cURL/JS/Python/PHP, and a try-it client.

Base URL & auth at a glance

curl https://app.ecardwidget.com/v2/api/pub/ecard-actions/send-ecard \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "senderEmail": "[email protected]",
    "senderName": "You",
    "recipientEmail": "[email protected]",
    "recipientName": "Ben",
    "type": "ecard"
  }'

Conventions

Base URL: https://app.ecardwidget.com
Auth: Bearer API key (Authorization: Bearer <YOUR_API_KEY>)
IDs are vanity IDs — short opaque strings (e.g. e4xgrzltk). Treat as opaque.
Most endpoints return { success, data, messages }. POST /ecard-actions/send-ecard is flat — fields at the top level.
Tenant isolation: every request is scoped to the account that owns the API key.