Deploy hooks
En deploy hook är en unik URL som utlöser en ny deployment av en environment när du skickar en HTTP POST-begäran till den. Det är sättet att göra en omdeploy utan att pusha en commit — användbart för externa innehållskällor, headless CMS webhooks eller schemalagda ombyggnader.
När du ska använda en deploy hook
- Externt innehåll — din webbplats hämtar innehåll från ett separat repository eller CMS vid byggtillfället. En ändring där pushar inte till ditt projekts repo, så ingenting deployas om automatiskt. Peka innehållskällans webhook mot en deploy hook för att bygga om vid varje innehållsändring.
- Schemalagda ombyggnader — ett cron-jobb eller schemalagd GitHub Action som kör
curlpå hooken enligt en timer. - Anpassade pipelines — vilket externt system som helst som ska starta en deployment.
Skapa en deploy hook
- Öppna environmenten och gå till dess Settings-flik.
- Under Deploy hooks, välj Create deploy hook.
- Ge den ett namn du kommer att känna igen senare (t.ex. "docs content rebuild") och bekräfta.
- Kopiera URL:en omedelbart — den visas bara en gång. URL:en innehåller en hemlig token och kan inte hämtas igen. Om du tappar bort den, återkalla hooken och skapa en ny.
Att skapa och återkalla deploy hooks kräver rollen Owner eller Admin i organisationen.
Utlösa en deployment
Skicka en POST-begäran till hook-URL:en:
curl -X POST "https://dashboard.velumi.com/api/deploy-hooks/<your-hook-url>"
Svaret berättar vad som hände:
200— en deployment startade.202— en deployment köades bakom en som redan körs. Den deployas automatiskt när den nuvarande är klar.
Båda svaren inkluderar det nya deploymentId så att du kan korrelera det i instrumentpanelen.
Hur det fungerar
- Deploymenten är identisk med en manuell deploy eller en push — den bygger från environmentens aktuella källa.
- Om en deployment redan körs, köas den nya triggern, inte avvisas — du förlorar inte en begäran genom att avfyra hooken under en byggnation.
- Om environmenten är stoppad, avvisas hooken (
409). Starta environmenten först.
Återkalla en deploy hook
I environmentens Settings-flik, välj Revoke bredvid hooken. URL:en slutar fungera omedelbart. Andra hooks på environmenten påverkas inte.
Återkalla en hook om dess URL kan ha läckt, eller när det externa systemet som använder den avvecklas.
Säkerhet
- Hook-URL:en är autentiseringsuppgiften — behandla den som ett lösenord. Vem som helst med URL:en kan utlösa en deployment av den environmenten (och inget annat — den kan inte läsa eller ändra din kod, variabler eller inställningar).
- Hemligheten visas en gång vid skapandet och lagras aldrig på ett sätt som vi kan visa dig igen.
- Lagra URL:en i dina CI/CD-hemligheter (t.ex. GitHub Actions secrets), inte i klartext i ett repository.
Begränsningar
- En deploy hook utlöser exakt en environment — den som den skapades på. Skapa separata hooks för separata environments.
- En hook deployas alltid från environmentens aktuella källa. Den kan inte deploya en specifik commit eller branch förutom den som environmenten redan följer.