Help center

Link Console API and webhooks

On Pro, the workspace owner creates an API key in Integrations to create and update links from other systems with the same naming rules, and owners and editors can send every link change to a webhook URL.

Connect another system

  1. Create an API key
    Open Integrations, API. Type a Key name, for example "HubSpot workflow", and press Create API key. Press Copy key now: it is shown only once.
  2. Call the API
    Send the key as Authorization: Bearer lc_... to https://links.planconversion.com/api/v1. Every endpoint and field is in the API reference.
  3. Handle naming errors
    A link that breaks your rules gets a 422 response with an issues list, one entry per problem. Fix the values, or add them to your approved values.
  4. Add a webhook
    Under Webhooks (Zapier, Make, n8n), paste an https URL, for example from Zapier's "Webhooks by Zapier, Catch Hook" or Make's "Custom webhook", and press Save. Press Send test to try it.
  5. Verify the signature
    The owner presses Copy signing secret. Each request carries X-LinkConsole-Signature: the hex HMAC-SHA256 of the raw body with that secret.
  6. Revoke keys you no longer need
    Press Revoke next to a key in the list. It stops working at once.

Example

curl -X POST https://links.planconversion.com/api/v1/links \
  -H "Authorization: Bearer lc_your_key" -H "content-type: application/json" \
  -d '{"destination":"https://www.example.com/demo","utm_source":"linkedin","utm_medium":"paid-social","utm_campaign":"q4-abm","short":true}'

Good to know

Related articles