canonical: https://jentic.com/apis/ecardwidget.com/ecardwidget # eCardWidget Developer API The eCardWidget Developer API sends eCards and keeps a team-member directory in sync from your own systems such as HR, CRM, or donation platforms. It sends, schedules, or shares eCards from a widget, lists the eCards a widget offers, and upserts, finds, lists, deactivates, reactivates, or deletes team members along with their mappable fields and departments. It also manages reward gift-card settings, products, orders, and inventory, and the widgets and automations that drive recognition. ## For AI agents Send eCards from a widget and keep a team-member directory in sync, plus manage reward gift cards, widgets, and automations for recognition programs. ## Scope Does not run payroll, track job applicants, or manage performance reviews. Use for sending eCards, syncing a team-member directory, and managing recognition rewards only. ## Capabilities - Send, schedule, or share an eCard from a widget - List the eCards available in a widget and search eCard designs - Create or update team members and find or list them - Deactivate, reactivate, or permanently delete a team member - List the mappable fields and departments used to sync your directory - Manage reward gift-card settings, products, orders, and inventory - Create, search, duplicate, and delete widgets and toggle automations ## Use cases ### Agent-driven recognition An AI agent connected through Jentic sends an eCard to a team member from a chosen widget, for a birthday or work anniversary, after finding the member in the directory. The agent lists the eCards a widget offers, picks one, and sends it, so a recognition moment is handled without a person opening the dashboard. Example prompt: Find a team member, list the eCards in a widget, and send one of them to that member ### Directory sync from HR or CRM Teams keep their eCardWidget team-member directory current by upserting members from an HR, HRIS, or CRM system and reading the mappable fields and departments to line the data up. The API exposes upsert, find, list, and deactivate operations plus a fields endpoint, so an agent can reconcile the directory against the source of truth. Example prompt: List the mappable fields, then upsert a batch of team members from an HR export and deactivate anyone no longer present ### Reward management Recognition programs that attach gift-card rewards read the reward account settings, available products, orders, and inventory to run them. eCardWidget exposes gift-card settings, product list, orders, rules, and inventory endpoints so an agent can check what is available and what has been sent before issuing more. Example prompt: List the available reward products and read the current reward rules and inventory before issuing a reward ### Widget and automation management Admins manage the widgets that hold eCards and the automations that trigger them by listing, searching, duplicating, and toggling them. The API exposes widget save, search, duplicate, and delete operations plus automation list and toggle, giving an agent control over how recognition is delivered. Example prompt: Search the widgets, duplicate one with its eCards, and enable the automation attached to it ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/pub/ecard-actions/send-ecard` | Send, schedule, or share an eCard | | GET | `/pub/ecard-actions/get-ecards` | List eCards in a widget | | POST | `/pub/team-member-actions/upsert` | Create or update a team member | | GET | `/pub/team-member-actions/list` | List team members | | GET | `/gift-card/listProducts` | List available reward products | | GET | `/widget/search` | List or search widgets | | GET | `/key/info` | Read what the API key is allowed to do | ## Key resources - **eCards** — List the eCards in a widget and send, schedule, or share one - **Team members** — Upsert, find, list, deactivate, reactivate, and delete members and read fields and departments - **Gift cards** — Read reward settings, products, orders, rules, and inventory - **Widgets** — List, search, save, duplicate, and delete widgets - **Automations** — List, read, and toggle recognition automations ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 67 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 74 / 100 - Developer Experience & Jentic Compatibility: 63 / 100 - AI-Readiness & Agent Experience: 54 / 100 - Agent Usability: 93 / 100 - Security: 60 / 100 - AI Discoverability: 82 / 100 - **View full report:** https://jentic.com/apis/ecardwidget.com/ecardwidget/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring eCardWidget by hand means handling its Bearer auth, checking the key-info endpoint for what a key can do, and running the upsert flow to reconcile your directory against an HR or CRM source yourself. Through Jentic you install once, import eCardWidget from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** eCardWidget carries widget and automation ids in the URL path, while team-member actions carry the member in the request body, so a rule bounds which operations your agent may call, such as sending eCards and reading the directory. You choose the operations it may call, so destructive ones like permanently deleting a team member or a widget are not included unless you add them. - **Credential handling:** Your eCardWidget token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'send an eCard' or 'upsert a team member', and Jentic returns the matching eCardWidget operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Bonusly** — Peer recognition and rewards, an alternative approach to eCardWidget's eCards and gift cards. - **SendGrid Mail** — Transactional email delivery that complements eCardWidget's card sending with your own messages. - **Postmark** — Reliable transactional email sending to pair with eCardWidget recognition flows. ## FAQ ### What authentication does the eCardWidget API use? The eCardWidget API authenticates with a Bearer token in the Authorization header per its OpenAPI spec, and a key-info endpoint reports what a given key is allowed to do. Through Jentic the token is stored once and injected at call time so it never enters the agent's prompt. ### Can I send an eCard with the eCardWidget API? Yes. You list the eCards a widget offers, then send, schedule, or share one through the send-eCard endpoint. The same widgets also hold the designs you can search and duplicate. ### What are the rate limits for the eCardWidget API? The OpenAPI spec does not publish fixed rate limits, but the gift-card endpoints expose velocity and spend limits with current usage for rewards. Check the eCardWidget documentation for the API limits that apply to your account. ### Is there an eCardWidget API MCP server? You don't need an MCP server to give your agent the eCardWidget API. Jentic connects it directly from the API Directory: import it, store your token once, and your agent sends eCards and syncs the directory on demand without loading another server's tool definitions into its context. ### Can I limit what my agent is allowed to do with the eCardWidget API? Yes. Write a rule that allows only the send-eCard and team-member read operations, so the agent can send cards and read the directory but cannot permanently delete members or widgets, and every call it makes is logged for review. ### How do I send recognition eCards with the eCardWidget API through Jentic? Search Jentic for 'send an eCard', add the eCardWidget API from the directory, and store your token once; your agent can then find a team member and send them an eCard from a widget on demand. To run it on your own infrastructure, install Jentic One from its GitHub repo.