Skip to content
hscli

Beacon

The beacon group helps you embed a Help Scout Beacon and wire up Secure Mode identity verification. See the command reference.

Embed a Beacon

Section titled “Embed a Beacon”
zsh — hscli
hscli beacon embed BEACON_ID --color "#1292EE" --position right

This prints the <script> block to drop into your site.

Secure Mode identity

Section titled “Secure Mode identity”

Generate the front-end identify snippet, and sign or verify a customer payload with your Beacon secret:

Terminal window
hscli beacon identify-snippet --beacon-id BEACON_ID --secret "$HSCLI_BEACON_SECRET"
hscli beacon sign --email customer@acme.io --secret "$HSCLI_BEACON_SECRET"
hscli beacon verify --email customer@acme.io --signature <sig> --secret "$HSCLI_BEACON_SECRET"