Comms
By default, you receive voucher credentials in the API response and deliver them to your customer yourself. Alternatively, Hubble can deliver each voucher directly to the customer over SMS, WhatsApp, or email.
This is a paid add-on, not a default capability. It must be enabled for your account before it starts working. Contact your Hubble account manager.
How It Works
Pass deliveryDetails in the Place Order request. The eligible channels depend on the contact details you provide:
| You provide | Eligible channel(s) |
|---|---|
deliveryDetails.recipientPhoneNumber | SMS and/or WhatsApp |
deliveryDetails.recipientEmail |
The exact channel mix also depends on your account configuration. Providing both a phone number and an email address does not guarantee that every channel fires.
- Sent only on
SUCCESS— if an order returnsPROCESSING, no message is sent until it resolves toSUCCESS. - One message per voucher — an order that generates multiple vouchers sends a separate message for each voucher, with that voucher's credentials.
Messages use Hubble's sender identity (WhatsApp Business number, SMS sender ID, or email address) and default voucher-delivery templates. They are not white-labeled as your brand unless a custom setup has been arranged.
Sample SMS/WhatsApp Format
Dear User,
Your #{brandName} Gift Card worth Rs #{amount} has been generated.
Card No: #{cardNumber}
Pin: #{cardPin}
Valid Till: #{validity}
Redeem before expiry. E-gift card cannot be revalidated after expiry.
Team Hubble
#{cardNumber}, #{cardPin}, and #{amount} come from the Voucher object. #{validity} is the voucher's validTill date.
Message templates and delivery channels can be customized for your integration. Contact your Hubble account manager to arrange this.
Resending
If a customer did not receive their vouchers, use Retry Voucher Delivery to resend using the deliveryDetails captured on the original order. Do not send deliveryDetails again.
This requires:
- The order to be in
SUCCESSstatus; otherwise the API returnsE302. deliveryDetailsto have been provided on the original order; otherwise the API returnsE305.- Vouchers to exist for the order; otherwise the API returns
E306. - Comms to be enabled and configured for your account; otherwise the API returns
E307.