Welcome to the eCardWidget Developer Portal, your hub for integrating, automating, and extending functionality using our platform.
You can access the Developer Portal via your main navigation: Settings > Developers.
Sections Overview
API Keys
Create and manage API keys needed to access and use eCardWidget API endpoints securely.
API Documentation
Access detailed API documentation and endpoint references for developers.
Webhooks
Webhook Settings
Set up a webhook URL to receive real-time notifications about eCard activity.
We send a
POSTrequest to your defined webhook URL.The request uses the header:
User-Agent: eCardWidget Hook.
Admin Controls
Add your endpoint URL in the Webhook URL field and click Save to begin receiving events.
Leave the field blank to disable webhooks.
Webhook Event Types
Event: ecard_shared
Triggered whenever an eCard is shared via email, social media, link, etc.
The webhook payload includes full metadata about the eCard, including sender/recipient info (if email), card ID, widget ID, and merge tags.
Sample Payload (ecard_shared):
[
{
"event_type": "ecard_shared",
"type": "email",
"allowExplicitTimestamps": false,
"created": "2025-03-26T15:37:27Z",
"do_notify_on_open": false,
"ecardid": 33561,
"ecomm_paid": false,
"has_custom_fields": false,
"has_image": false,
"id": "r5hzjsd5dfwcxfn8qsksb",
"locale": "en",
"merge_tags": "{\"custom_value_used_in_ecard_content_or_tracking\":\"Acme Corp\"}",
"opened": false,
"ownerid": 1,
"parameterize": true,
"personal_message": "",
"recipient_email": "[email protected]",
"recipient_name": "Tim",
"recipient_total": 1,
"recipients": "[]",
"scheduled_to_be_sent_at": "2025-03-26T15:37:27Z",
"sendAt": "",
"sender_email": "[email protected]",
"sender_name": "Bob Sender",
"sender_opted_in": false,
"sender_optin": false,
"sender_request_id": "r5hzjsd5dfwcxfn8qsksb",
"sender_teammemberid": "",
"sent": false,
"shopify_paid": false,
"shopify_precheckout": false,
"stripe_order_id": "",
"validate": true,
"vanity_id": "slg4y4wpqqmjwb4",
"widgetid": 10778,
"override_props": "{\"envelope_confetti\":true}"
}
]
Important Notes:
The
sentfield is alwaysfalsebecause the webhook is triggered before email dispatch.Use
scheduled_to_be_sent_atto determine expected send time.
type Field Possible Values:
emailunique_ecard_openfacebookecard_instagram_dlsmslinkedintwitterwhatsappecard_downloadecard_copy_link
For further API details and support, visit the Developer Portal inside your dashboard under Settings > Developers.