Webhooks

Webhooks allow you to receive real-time notifications when your links are clicked. When a click occurs, Linkly sends a POST request to your specified URL(s) with detailed information about the click.

• Zapier Integration: Trigger Zaps when links are clicked
• Custom Analytics: Send click data to your own analytics system
• CRM Updates: Update customer records when they click links
• Slack Notifications: Get notified in Slack when important links are clicked
• Lead Tracking: Track when prospects engage with your links

To receive notifications for clicks on a specific link:

1. Go to Links and click on the link you want to configure
2. Scroll down to the Webhooks section
3. Enter your webhook URL(s), one per line
4. Click Save Link

Link-level webhooks only fire when that specific link is clicked.

To receive notifications for all clicks across your entire workspace:

1. Go to Settings (gear icon in the sidebar)
2. Find the Webhooks field
3. Enter your webhook URL(s), one per line
4. Click Save Settings

Workspace-level webhooks fire for every click on any link in your workspace.

Note: If you configure webhooks at both levels, both will fire for clicks on that link.

When a click occurs, Linkly sends a POST request with the following JSON payload:

{
  "event": "click",
  "timestamp": "2025-01-15T10:30:00Z",
  "link": {
    "id": 12345,
    "name": "My Campaign Link",
    "url": "https://example.com/landing-page",
    "full_url": "https://yourdomain.com/abc123",
    "domain": "yourdomain.com",
    "slug": "/abc123",
    "destination": "https://example.com/landing-page",
    "workspace_id": 1,
    "enabled": true,
    "cloaking": false,
    "forward_params": true,
    "block_bots": true,
    "public_analytics": false,
    "utm_source": "newsletter",
    "utm_medium": "email",
    "utm_campaign": "spring-sale",
    "og_title": "Special Offer",
    "og_description": "Check out our spring sale!",
    "rules": [
      {
        "what": "country",
        "matches": "US",
        "url": "https://example.com/us-landing"
      }
    ]
  },
  "click": {
    "country": "US",
    "is_eu_country": false,
    "platform": "desktop",
    "browser_name": "Chrome",
    "referer": "https://twitter.com/",
    "isp": "Comcast",
    "bot_name": null,
    "destination": "https://example.com/landing-page",
    "params": {
      "utm_source": "twitter"
    }
  }
}

Privacy Note: IP addresses are never included in webhook payloads.

For Zapier, use our native Zapier integration which includes instant click triggers powered by webhooks.

You can add multiple webhook URLs (one per line). All URLs will receive the same payload when a click occurs.

• Webhooks are fire-and-forget - Linkly does not retry failed deliveries
• Webhook failures never affect the redirect - users always reach their destination
• Ensure your webhook endpoint responds quickly (< 5 seconds recommended)

• Use HTTPS endpoints for webhook URLs
• Validate incoming requests in your webhook handler
• Consider adding a secret parameter to your webhook URL for verification

1. Set up a webhook URL using a service like webhook.site or RequestBin
2. Click your link
3. Inspect the received payload
4. Once verified, switch to your production webhook URL

1. Check the URL: Ensure your webhook URL is valid and accessible
2. Check link settings: Verify webhooks are saved on the link or workspace
3. Check click recording: Webhooks only fire when clicks are recorded (not for excluded IPs or skipped crawlers)

Some fields may be null if:

• The information wasn't available (e.g., no referer)
• Privacy settings prevented collection
• The click was from a bot (bot_name will be populated instead)

• No retries: Failed webhook deliveries are not retried
• No delivery confirmation: Linkly does not track webhook delivery status
• 5-second timeout: Webhook requests timeout after 5 seconds

You can also manage webhooks programmatically via the API:

POST   /api/v1/link/:link_id/webhooks
DELETE /api/v1/link/:link_id/webhooks/:hook_id
GET    /api/v1/link/:link_id/webhooks

POST   /api/v1/workspace/:workspace_id/webhooks
DELETE /api/v1/workspace/:workspace_id/webhooks/:hook_id
GET    /api/v1/workspace/:workspace_id/webhooks

See the API Documentation for details.