Skip to main content
GET
Get Link

Authorizations

Authorization
string
header
required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

Send the signed JWT as a bearer token:

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Path Parameters

id
integer
required

Link ID

Response

The Link

id
integer<int64>

Unique identifier for the link.

Example:

42

short_code
string

Code segment of the short URL.

Example:

"AbCd12"

short_url
string<url>

Full short URL to include in messages.

Example:

"https://r.hey.mk/AbCd12"

original_url
string<url>

Destination URL the short link redirects to.

Example:

"https://example.com/promo"

team_id
integer<int64>

Unique identifier for your team.

target
string

Target the link is attributed to.

conversation_id
integer<int64>

Conversation the link is attributed to.

broadcast_id
integer<int64>

Broadcast the link is attributed to.

campaign_step_id
integer<int64>

Campaign step the link is attributed to.

template_id
integer<int64>

Template the link is attributed to.

last_visited_at
string<date-time>

Timestamp of the most recent click. Omitted when the link has never been clicked.

created_at
string<date-time>

Creation date.