Features
Let Bots send email, and what this feature does not control, including the emails Ovok sends itself.
Lets Bots in the project send email. It controls email sent by your automations, not the emails Ovok sends on its own behalf.
| Type | Project feature |
Value in features | email |
| Change with | PATCH /v1/projects/me/features (replaces the whole list) |
| Who can change it | Project admin. Any practitioner can read the list. |
| On for new projects | Yes |
| Needs | bots |
| When off | A Bot's attempt to send email is refused with 403 |
What it enables
A Bot sends email through the Bot SDK's sendEmail call, which posts to /email/v1/send on the FHIR host. The platform accepts the send only when the Bot's project has email and the caller is a project admin.
Turn it on
curl --request PATCH \
--url 'https://api.sandbox.ovok.com/v1/projects/me/features' \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--header 'Content-Type: application/json' \
--data '{"features":["bots","cron","email","transaction-bundles","websocket-subscriptions"]}'What this feature does not control
| What controls it | |
|---|---|
| Invitations, password resets and other messages Ovok sends itself | Not this feature, and not MAILING_ENABLED. They are sent when the template is mapped and its provider is ready: see Email templates. |
| Where the links in those emails point | PATIENT_APP_URL and PRACTITIONER_APP_URL |
Turning email off therefore does not stop invitation or password-reset emails.
What callers see when it is off
403 (Forbidden) from /email/v1/send. In a Bot this surfaces as an error from sendEmail.
Gotchas
- Two conditions, one
403. The send is refused if the project lacksemailor the caller is not a project admin. If a Bot still gets403with the feature on, check the Bot's membership as well as the features list. - A successful response means "accepted", not "delivered". Delivery depends on the platform's mail configuration, and the call does not report whether a message was actually sent.
emailwithoutbotsis useless. Bots are the only way to reach it. Add bots.- Projects created before this was a default can lack it. Call
GET /v1/projects/me/featuresand check.
Related
- Email templates, for the emails Ovok sends itself
- bots
- MAILING_ENABLED
- PATIENT_APP_URL
Last updated on