Developer API

Developer API, Webhooks & Audit Log

Automate link management with Linky's REST API on the Business plan. Create API keys, receive outbound webhooks, and review account activity.

Get started free

API demo

POST /api/v1/links

POST/api/v1/links

Authorization: Bearer lk_••••••••201 Created

Request body

{
  "originalUrl": "https://shop.com/sale",
  "slug": "summer-sale",
  "title": "Summer promo"
}

Response

{
  "id": "lnk_8x2kq9m",
  "slug": "summer-sale",
  "shortUrl": "go.yourbrand.com/summer-sale"
}

Same fields as the dashboard create form

14+

Endpoints

Webhook events

REST

JSON API

Read the docs

Toolkit

Automate everything. Audit everything.

The dashboard is the UI - the API is the engine. Create keys, register webhooks, and review every action in the activity log.

REST API v1

Full CRUD for links, rules, domains, and analytics under /api/v1.

API keys

Bearer tokens created in Settings - shown once, revocable anytime.

Webhooks

Real-time link.created, link.updated, and link.clicked events to your HTTPS endpoint.

Audit log

Every API key change, webhook edit, and link action logged for Business accounts.

Endpoints

REST API v1

Every dashboard action has an API equivalent under /api/v1. Authenticate with an API key in the Authorization header.

/api/v1 routes

GET/api/v1/linksList links
POST/api/v1/linksCreate link
GET/api/v1/links/{id}Get link
PATCH/api/v1/links/{id}Update link
DELETE/api/v1/links/{id}Delete link
POST/api/v1/links/bulkBulk create
GET/api/v1/links/{id}/clicksAnalytics
GET/api/v1/links/{id}/qrQR download
GET/api/v1/links/{id}/rulesList rules
POST/api/v1/links/{id}/rulesAdd rule
GET/api/v1/domainsList domains
POST/api/v1/domainsAdd domain
GET/api/v1/webhooksList webhooks
POST/api/v1/webhooksRegister webhook

Webhooks

Outbound webhooks

link.created
New short link saved via API or dashboard
link.updated
Destination, slug, title, or metadata changed
link.clicked
Someone visited your short URL - includes geo and device
Signed payloads with a shared secret
Test delivery from the dashboard

Audit

Activity log

Business accounts get an audit trail of API key and webhook changes, plus link actions performed via the API or dashboard.

Activity logBusiness plan

10:22:01link.clickedsummer-sale → US/mobile
09:14:33link.updatedDestination changed
08:55:12webhook.createdhooks.acme.io/linky
08:30:00api_key.createdProduction key

Auth

One header. Every request.

Create an API key in Settings, then authenticate with a Bearer token on every call. Keys are shown once - store them securely.

curl -X POST "https://your-site.com/api/v1/links" \
  -H "Authorization: Bearer lk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"originalUrl":"https://example.com","slug":"launch"}'

Full reference at /docs/api.

Where it helps

Built for teams that ship with code

Whether you are wiring Linky into a deploy pipeline or building a custom client portal - the API mirrors the dashboard exactly.

Deploy pipelines

Create campaign links automatically when a release ships or a promo goes live.

CRM sync

Push click events into Salesforce or HubSpot via webhooks - no polling.

Analytics warehouse

Pull click data into BigQuery or Snowflake on a schedule with the REST API.

Client tooling

Build internal dashboards that manage hundreds of links across accounts.

FAQ

Which plan includes the API?

REST API access, API keys, webhooks, and the activity log are included on the Business plan ($49/mo). Create keys from Developers after upgrading.

How do I authenticate?

Create an API key under Developers, then send Authorization: Bearer lk_your_key on every request. Keys are shown once at creation - store them securely.

Get started

Your stack. Our API.

Upgrade to Business, create your first API key, and automate link management in minutes.

Get started free