Admin
See which messages the API sent
Messages your own systems send through the BloomText API show the key's name and an API label. Admins see and revoke each key in organization settings.
Who can do this: Admins and staff · Web and desktop
Your practice's own systems, such as a scheduling system that sends reminders, can text patients through the BloomText API. Each message they send shows the name of the API key that sent it, so your team can tell it apart from a coworker's message. Replies land in the same chat, like any other text.
Before you start
- Anyone in the chat sees the API label. Only organization admins see the API keys tab.
- API access is for organizations with a signed BAA. To get a key, contact BloomText.
Spot a message from the API
- Your scheduling system texted Maria a reminder. Click her chat in the Inbox.
- The message is labeled Reminder service · API: your system sent it, not a coworker.
- Maria's reply lands in the same chat, so the team picks it up like any other text.
Find the key that sent it
- From the Inbox, click Settings at the bottom left.
- Click Organizations to see the practices you belong to.
- Click your practice. Only organization admins see its API keys.
- Click the API keys tab.
- Each key shows the name its messages show, for example Reminder service, with its status, scopes, and when it was created and last used. Click Revoke to stop its texts.
Good to know
- BloomText asks you to confirm before it revokes a key. Apps using it stop working immediately.
- Admins can also set or change a key's expiry from its row.
- Search results show the same API label next to the key's name.
- For developers, the API keys guide covers scopes, expiry and how to send a key.