Create link
Create a tracked short link for a destination URL.
Authorizations
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.
Body
Link json
Destination URL. Must use the http or https scheme and be at most 2048 characters.
"https://example.com/promo"
Conversation to attribute the link to.
Broadcast to attribute the link to.
Campaign step to attribute the link to.
Response
The created Link
Unique identifier for the link.
42
Code segment of the short URL.
"AbCd12"
Full short URL to include in messages.
"https://r.hey.mk/AbCd12"
Destination URL the short link redirects to.
"https://example.com/promo"
Unique identifier for your team.
Target the link is attributed to.
Conversation the link is attributed to.
Broadcast the link is attributed to.
Campaign step the link is attributed to.
Template the link is attributed to.
Timestamp of the most recent click. Omitted when the link has never been clicked.
Creation date.