helpscout

Mint the signed identity the Help Scout Beacon needs

Sign the user's email address with the Beacon secure-mode key, and return it with the details the support widget fills its form and conversation with.

post/helpscout/identity/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/helpscout/identity/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Response

Successful Response

companystring required

The workspace they are writing from.

emailstring required

The address the signature below was computed over.

namestring nullable required

The customer's full name, or null when Clerk holds neither part.

org_idstring required

Clerk organization id, for looking the workspace up.

rolestring required

Their role in that workspace.

signaturestring required

HMAC-SHA256 hex signature of the email, which Beacon secure mode checks before it trusts the identity the page claims.

user_idstring required

Clerk user id, for looking the person up.

Changes

No recorded changes to this operation across all 1 revision of this API.