<aside> 📌 Herald helps product and customer teams work together to paint a full picture of user problems. 🙌

</aside>

<aside> 🔑 This question is part of Herald: Frequently Asked Questions. Have a question that's not answered there? Our bad, give us a chance to answer your question: we're only an e-mail away: [email protected].

</aside>

How to Integrate the Herald Public Portal?

There are two ways to integrate your public portal with your app.

• Zero cost integration: Just provide users a link to your public portal. We allow them to sign in by sending a "magic link" to their email. Go directly to Step 3 below and ignore the token part of the URL.
• API integration: Provide users a specially generated link that seamlessly logs them in to your public portal. This requires a small amount of engineering work as there is a caveat: Herald needs to know the user ID of your users. We can grab them easily if your team enables the Intercom integration. An alternative is to provide us with user information using our API. Take a look at https://api.heraldhq.com/#operation/UpsertContact.

Step 1: Generate a Herald API key and copy the ID and Secret

From "Settings >> Workspace", create a Herald API key:

Step 2: Use your backend to generate a secure user token

Herald's Public Portal requires a secure token to identify the user. This token is based on the JSON Web Token (JWT) standard, and be generated by your backend with only a few lines of code. There are open source JWT libraries for most languages.

Here is sample code in selected languages (let us know if you need it for another language):

Node.js (Typescript)

PHP

Note: for sake of security, Herald will reject all JWTs with an expiration longer than 30 days, so please set expiration to less than that.

Step 3: Choose how to integrate with Herald's Customer Portal

Present a link to your customer of the format: https://[slug].herald.fyi/[slug]?token=[token], where slug is your Herald workspace slug and token is the user token generated by step 2 above.

You may also redirect the user to specific component of the Herald Public Portal:

• Roadmap - https://[slug].herald.fyi/[slug]/roadmap?token=[token]
• Changelog - https://[slug].herald.fyi/[slug]/changelog?token=[token]