Switching on SMS Appointment Texts
Groups with the Esendex SMS integration can send automated booking confirmations and reminder text messages directly to patients' mobile phones. Setup takes approximately 20 minutes and requires connecting your group's Esendex account before enabling individual pharmacy branches.
[Navigation: Manager portal > your name (top right) > System settings > Integration API details]
What Your Patients Receive
Section titled “What Your Patients Receive”Text messages serve as an addition to—never a replacement for—your standard email confirmations and reminders. Patients receive up to two texts per appointment if they opt in during booking:
- Booking Confirmation: Sent within 5 minutes of booking (“Riverside Pharmacy: your appointment is booked for 18/09 at 09:00 at Riverside Pharmacy Main Street. To change it call (01) 234 5678.”).
- Appointment Reminder: Sent prior to the visit based on your group’s existing reminder schedule (“Riverside Pharmacy: a reminder of your appointment on 18/09 at 09:00 at Riverside Pharmacy Main Street. To change it call (01) 234 5678.”).
Integration Overview & Billing
Section titled “Integration Overview & Billing”- Deltera Setup: The integration is granted at the group level, making SMS options visible in your group settings and on each pharmacy’s integrations page.
- Your Steps: Complete 5 setup steps: register an Esendex account, retrieve your API credentials, set a sender ID, and enable target branches.
- Account & Billing: Usage is billed directly to your organisation’s own Esendex account. Deltera dispatches the messages on your behalf without reselling or markup fees.
Step-by-Step Integration
Section titled “Step-by-Step Integration”1. Open an Esendex Account
Section titled “1. Open an Esendex Account”- Sign up for an account at esendex.ie.
- Note your Account Reference code (formatted like
EX0123456). - Request that Esendex move your account off trial status before going live.
⚠️ Warning: Trial Account Sender LimitationsOn a trial account, messages are sent using a shared sender ID. Patients will see “Esendex” in the header instead of your pharmacy name until the account is upgraded to a live plan.
2. Retrieve Your API Username and Password
Section titled “2. Retrieve Your API Username and Password”- Request your account’s API password from Esendex (a long code containing letters, numbers, and dashes).
- Confirm the username associated with the key (typically the email address used to log into Esendex).
💡 Irish and Northern Irish AccountsEsendex uses its core API for Irish and Northern Irish accounts, authenticating with a Username and API Password. Deltera fully supports this. If you are using a UK Esendex account and were issued an API key via Developer tools, enter that key into the credential field and leave the username blank.
3. Set Your Sender ID
Section titled “3. Set Your Sender ID”Configure your default sender header within your Esendex account settings:
- Virtual Mobile Number: Works immediately without additional registration.
- Branded Name: Requires network approval from mobile providers, so allow extra lead time before launching.
4. Enter Credentials in Your Portal
Section titled “4. Enter Credentials in Your Portal”[Navigation: Manager portal > your name (top right) > System settings > Integration API details]
- Log in to the Manager portal as an administrator.
- Navigate to System settings > Integration API details.
- Fill in Account reference, Username, and API key or API password.
- Click Save integration details.
**⚠️ Critical Warning: Do Not Leave Username Blank (ROI Accounts)**Leaving the username field blank causes the system to treat the password as a UK-style API key, resulting in Esendex rejecting all outgoing texts. Failed attempts will not show up in your Esendex log, making this easy to overlook.
5. Switch On Each Pharmacy
Section titled “5. Switch On Each Pharmacy”[Navigation: Manager portal > Pharmacies > Select Branch > Integrations]
- Navigate to Pharmacies and select your target branch.
- Click Integrations.
- Check the SMS box and click Save.
- Repeat for every branch that should text patients.
Verifying Your Integration
Section titled “Verifying Your Integration”Make a test booking through your public booking link at an enabled branch using your own mobile number, selecting Yes for Would you like a text reminder?. The confirmation text should land within 5 minutes.
Texting Manually Booked Patients
Section titled “Texting Manually Booked Patients”When pharmacy staff book an appointment directly (rather than the patient booking online), SMS confirmations can be sent manually.
Note: SMS options only display for branches with SMS enabled and are hidden for remote consultations where physical branch addresses do not apply.
Option A: Booking a New Appointment (Pharmacist Portal)
Section titled “Option A: Booking a New Appointment (Pharmacist Portal)”[Navigation: Pharmacist Portal > Appointment Calendar > New Appointment]
- Complete the patient demographic details as usual, ensuring a mobile phone number is included.
- Check Text the patient their confirmation and reminder (located below the email checkbox at the bottom of the form).
- Click Create appointment. The text confirmation dispatches alongside the confirmation email.
Option B: Updating an Existing Appointment (Pharmacist or Pharmacy Portal)
Section titled “Option B: Updating an Existing Appointment (Pharmacist or Pharmacy Portal)”- Open the appointment record from your schedule or calendar queue.
- Locate the check section below Send details to patient when I click update.
- Check Text the patient their confirmation and reminder.
- Ensure Send details to patient is also checked (the SMS confirmation will only fire if patient notification is enabled).
- Click Update.
Understanding Post-Save Status Messages
Section titled “Understanding Post-Save Status Messages”After saving, the portal may display status feedback regarding text delivery:
- Already texted this appointment time: The patient has already received an SMS confirmation for this specific time slot. No action required.
- An earlier text hasn’t been confirmed: A previous text dispatch is currently awaiting confirmation from Esendex. It was not re-sent to avoid duplicating messages to the patient.
- The text message was not sent: Indicates a failure, typically due to an invalid or missing mobile number. Review the phone number formatting and update again.
Pre-Flight Setup Checklist
Section titled “Pre-Flight Setup Checklist”Before entering credentials in Step 4, gather the following details:
- Account Reference: Found on your Esendex account page (e.g.
EX0123456). - Username: The primary email address used to sign into your Esendex account (e.g.
you@yourpharmacy.ie). - API Password: Issued by Esendex (e.g.
1a2b3c4d-…). - Sender ID: Virtual number or registered brand header configured in Esendex settings.
- Branch Rollout List: List of specific branches designated for SMS activation.
Important Operational Rules
Section titled “Important Operational Rules”- Patient Consent Required: Text messages are only dispatched to patients who select Yes on the online booking form or explicitly consent during manual staff bookings. Existing bookings made prior to enabling SMS will not automatically receive retrofitted texts.
- Irish Mobile Support: Supports standard Irish formats (
087 123 4567) and international formatting (+353871234567). Landline numbers are skipped automatically. - Group-Level Credentials: All active branches within your organisation send messages using the single group-level Esendex account and sender ID.
- Unmonitored Replies: Patient replies sent to virtual mobile numbers land inside your central Esendex web inbox and will not display inside the Deltera portal.
- Single-Message Formatting: Messages are formatted to fit within a single SMS segment wherever possible. Unusually long pharmacy names may be shortened automatically to avoid multi-part message charges.