Developer Portal Overview #
Everything you need to build with eCardWidget lives under Settings → Developers in the dashboard: API keys, the API reference, and webhooks.
API Keys #
Create and manage the keys used to authenticate API requests.
- A key is shown in full only once, at creation — copy it somewhere safe. Afterward only the first and last few characters are shown.
- Give each key a label so you can tell integrations apart.
- Delete a key to revoke it immediately.
- Use the key as a Bearer token on every request:
Authorization: Bearer YOUR_API_KEY(see Getting Started).
API Documentation #
Links to the interactive API reference and endpoint details (the same content as
reference/openapi.yaml in this repo).
Webhooks #
Webhooks push events from eCardWidget to your server in real time. There are two families:
ecard_shared— set a Webhook URL here and click Save to receive aPOST(User-Agent: eCardWidget Hook) whenever an eCard is sent/shared. Blank disables it.- Directory member-change webhooks — subscribe via the API to team-member changes (created / updated / deactivated / deleted) for two-way HR/CRM sync.
See Webhooks for both — full payloads, event types, signing, and the
subscribe/unsubscribe endpoints.
Related #
- Getting Started — auth, base URL, response shapes, errors
- Send eCards via API
- Directory Sync API
- JavaScript (widget) events
- Full reference:
reference/openapi.yaml