Vercel integration and template
Coming soonComing soon: add FunctioningHQ from your Vercel dashboard, with the signal key and widget in your project’s environment and every deploy recorded as a release. What to do meanwhile is on the page.
Coming soon. Nothing here is built yet, and nothing in the product offers to connect it. This page says what it will do and what to do meanwhile, so you can decide whether to wait.
What it will do
Add FunctioningHQ from your Vercel dashboard, as a connectable account integration:
- the signal key and the widget id land in your project's environment variables, for every environment you choose, so
connect what you haveis one click rather than a copy and paste; - every deploy is recorded on History as a release, through a deploy hook, so a measurement that straddles a release says so instead of quietly attributing the change to a play;
- a template you can deploy that wires the widget and the signals API into a new project, as a worked example rather than a starting point you have to reverse-engineer.
Receiving a deploy event never authorizes anything. A credential that lets a source send us signals is separate from permission to act on that system, and the integration will follow that rule like every other source.
What to do meanwhile
Everything the integration would do, by hand, in about five minutes:
- Issue a signal key under Settings › Sources and put it in your Vercel project's environment as
FUNCTIONINGHQ_SIGNAL_KEY. The contract is in Sending signals. - Add the widget snippet from Settings › Help widget to your app's layout. The contract is in Help and feedback widget.
- Record your releases by posting a context event when a deploy finishes. A Vercel deploy hook pointed at the signals endpoint does it:
curl -X POST https://functioninghq.com/api/signals \
-H "Authorization: Bearer $FUNCTIONINGHQ_SIGNAL_KEY" \
-H "Content-Type: application/json" \
-d "{
\"events\": [
{
\"id\": \"deploy-$VERCEL_DEPLOYMENT_ID\",
\"kind\": \"release\",
\"startsAt\": \"$(date -u +%Y-%m-%dT%H:%M:%SZ)\",
\"note\": \"Deployed $VERCEL_GIT_COMMIT_SHA\"
}
]
}"
A release recorded this way appears on History beside everything the loop did, and every measurement that overlaps it says so.
When it lands
It is on the integrations table as coming soon, and this page becomes the integration's documentation rather than a placeholder. Nothing about the by-hand route above stops working when it does.
Something missing, or a field that does not behave as this says? Tell us — the contracts here are what the code is held to, so a page that is wrong is a bug in the same sense the code would be.