Docs / LinkQR
Signup

API and Webhooks

Create API keys, connect external systems, and subscribe to short-link events.

Estimated reading: 3 minutes

API and Webhooks

API and Webhooks are developer tools for connecting Short URLs with external systems such as CRMs, internal dashboards, automation tools, reporting pipelines, or customer portals.

API keys

API keys are bearer tokens used by trusted integrations. They can be used to create or read short links depending on the available API permissions.

  • Create separate keys for production, staging, CRM sync, or internal tools.
  • Use clear names so admins know which integration owns each key.
  • Store keys securely and never expose them in browser-side JavaScript.
  • Rotate keys if a team member leaves or an integration is replaced.
  • Revoke unused keys to reduce security risk.

Webhooks

Webhooks send event notifications to an external endpoint. They are useful when another system needs to react after a link is created or clicked.

  • Link created: send new short-link data to a CRM, reporting tool, or audit system.
  • Link clicked: send click activity to analytics or automation workflows when available.
  • Test webhook: confirm the endpoint receives payloads before production use.
  • Signed payloads: verify signatures where supported to confirm the event came from LinkQR.

Security notes

  • Use HTTPS endpoints for webhook URLs.
  • Do not share API keys in support tickets or public screenshots.
  • Limit API access to trusted systems.
  • Disable keys and webhooks that are no longer used.

API and Webhooks - Detailed Feature Guide

Feature Purpose

Create API keys, connect external systems, and subscribe to short-link events. This feature is part of the LinkQR workflow and should be documented as an operational tool, not just a menu item.

Main Capabilities

  • Provides a focused workspace for this product area.
  • Helps users complete the related task without switching modules.
  • Connects with plans, permissions, analytics, and workspace ownership where relevant.
  • Should be configured and tested before being included in customer workflows.

Typical Workflow

  1. Open the API and Webhooks page from the sidebar.
  2. Review the existing records, settings, or campaign state.
  3. Create or update the required item.
  4. Validate important fields before saving.
  5. Preview or test the public/user-facing result when applicable.
  6. Use analytics, logs, or reports to confirm the feature is working as expected.

Admin Configuration Notes

  • Confirm the feature is enabled in the correct plan.
  • Check workspace ownership when users work inside a team.
  • Review related limits such as credits, storage, QR count, scan count, or team members.
  • Clear cache and test again after changing global settings.

Customer-Facing Benefits

  • Reduces manual work and makes campaign setup faster.
  • Keeps campaign assets organized and easier to maintain.
  • Improves reliability by keeping important setup steps inside one workflow.
  • Supports better reporting and troubleshooting after launch.

Troubleshooting Checklist

  • If the feature is not visible, check plan permission and user role first.
  • If saved data does not appear publicly, verify publish/status settings.
  • If a public URL is involved, test the URL in a private browser session.
  • If team workspaces are involved, confirm the item belongs to the correct owner workspace.
  • If tracking or analytics is involved, confirm the visitor action uses the tracked dynamic URL.