To use Hellō in your app, you will need to register your app, and add a Hellō button.
If you are writing your own application, integrating Hellō is straight forward and does not require any frameworks or third party libraries.
If you are configuring a platform to use Hellō, you will need to copy and paste values between the Hellō console and the platforms administrative console.
In the future we will have plug-ins for popular platforms that will simplify using Hellō. If you are interested in writing a plug-in, please reach out firstname.lastname@example.org.
1. App Registration
To use Hellō, register your application at console.hello.coop. You can start developing with just the Client ID and the defaults, which includes the Development Redirect URIs
2. Standard Hellō Buttons
To add a Hellō Button to your page:
<head> of your document.
<head> <!-- ... -->
<link href="https://cdn.hello.coop/css/hello-btn.css" rel="stylesheet"/> <script src="https://cdn.hello.coop/js/hello-btn.js"></script>
2.2 Include the HTML for the Hellō Button in your page:
Don't see your locale? We encourage you to create a translation for your locale per
hellocoop/wallet-i18n and submit a pull request for review.
3. Custom Button Label
You can override the default "Continue with Hellō" button text by setting the
data-label attribute of the button like this:
<button class="hello-btn hello-btn-white-and-static" data-label="ō Update Profile with Hellō" ></button>
4. Self-Managed Hellō Buttons
If you are concerned with including a script from Hellō, you can find the source code at hellocoop/button. You can use this as a reference to create your own buttons.
If you don't want to use the Hellō stylesheet, the Hellō button is either charcoal (#303030) on white, or white on charcoal. Note that the Hellō logo
ō is an
o with a macron. You can use the
ō character if you have
<meta charset="UTF-8"> in your page
<head> element (best practice for HTML documents). For reference, the UTF-8 encoding is
0xC5 0x8D and the HTML markup is
5. Select Claims
You request claims from Hellō by including a scope for that claim in your request. Any claims you request from Hellō are required claims, IE the user will need to provide a value. Hellō only supports verified email and phone claims. Unverified email and phone are not supported. Hellō Claims provides a full list of supported scopes and associated claims.
Hellō will always return the
sub claim, a globally unique identifier in the form of a GUID, that you can use to identify the user across any apps under your publisher. The
sub claim is unique to your publisher for a given user. Other publishers will receive a different
sub claim for the user.
Note that it is best practice to only request the claims you require. For example, you may only need a preferred name to address the user initially, and a verified email address when they would like a notification. Hellō makes it easy to do incremental consent and request additional claims once you need them.
6. Add Hellō to your application
If you are writing your own application, see Integrating Hellō. If you are configuring Hellō in a platform, see Hellō & Platforms