CircleCI workflow completed notifications on your phone.
Get a High-priority push notification when a CircleCI workflow fails or errors, and optionally a quiet one when it passes.
Monday 5 October
9:41
JustPushnow
Workflow completed
Get a High-priority push notification when a CircleCI workflow fails or errors, and optionally a quiet one when it passes.
Three steps to your first push
STEP 01
Install the recipe
One click in Studio gives you a personal webhook URL.
STEP 02
Paste your URL into CircleCI
Add it as a webhook for Workflow Completed.
STEP 03
Get a push on your phone
With the text, sound and buttons from the recipe.
How to set up the CircleCI workflow completed webhook
- Click Install in Studio and sign in. The recipe is added to your account and you get a personal webhook URL.
- In CircleCI, open your project's Project Settings > Webhooks and click Add Webhook (organization admins only).
- Give it a name, paste your webhook URL as the URL and keep Certificate Validation on.https://••••••••/•••••••• your personal URL, shown after install
- Tick the Workflow Completed event and save.
- Click Test Ping Event to confirm it arrives.
- In your project's **Project Settings → Webhooks**, add a webhook with the URL above and tick **Workflow Completed** (not Job Completed, or you'll get pushes for every job as well). A project can have up to five webhooks, and only organization admins can add them.
- Only failed, errored and unauthorized workflows push by default. Add `?all=1` to the URL to also get a quiet push when a workflow succeeds or is canceled:
- ```
- your webhook URL?all=1
- ```
- **Test Ping Event** sends a quiet **🔔 CircleCI connected** push.
- CircleCI signs each delivery with your secret token (`circleci-signature: v1=…`, HMAC-SHA256), but JustPush doesn't check that signature yet, so keep your endpoint URL private. You can leave the secret token empty.
What runs when the webhook arrives
Studio calls handleRequest(request) with the incoming webhook and sends the message it returns. It's yours after install; change anything.
transform.js
1// CircleCI → workflow-completed
2// Fires when a CircleCI workflow reaches a final state. Failures push by default; add ?all=1
3// to the webhook URL to also hear about successful and canceled workflows.
4// Docs: https://circleci.com/docs/reference/outbound-webhooks-reference/
5
6// Workflow statuses, how to describe them, and whether they push without ?all=1.
7const STATUSES = {
8 failed: { emoji: "❌", verb: "failed", priority: 1, always: true }, // broken build: needs you soon
9 error: { emoji: "❌", verb: "errored", priority: 1, always: true }, // config or infrastructure error
10 unauthorized: { emoji: "🔒", verb: "was not authorized", priority: 1, always: true }, // e.g. a restricted context
11 success: { emoji: "✅", verb: "passed", priority: -1, always: false }, // good news, only with ?all=1
12 canceled: { emoji: "⏹️", verb: "was canceled", priority: -1, always: false }, // on purpose, only with ?all=1
13}
14
15// Look a key up in a table without tripping over inherited names like "toString".
16function pick(table, key, fallback) {
17 return typeof key === "string" && Object.prototype.hasOwnProperty.call(table, key) ? table[key] : fallback
18}
19
20// Header names can arrive in any case.
21function header(request, name) {
22 const headers = request.headers || {}
23 const key = Object.keys(headers).find((k) => k.toLowerCase() === name)
24 const value = key ? headers[key] : null
25 return Array.isArray(value) ? value[0] : value
26}
27
28// Treat blank or non-string values as missing.
29function text(value) {
30 return typeof value === "string" && value.trim() ? value.trim() : null
31}
32
33// Only link to real http(s) URLs.
34function link(url, cta) {
35 return typeof url === "string" && /^https?:\/\//.test(url) ? [{ cta, url }] : []
36}
37
38function handleRequest(request) {
39 const body = request.body && typeof request.body === "object" ? request.body : {}
40 const event = header(request, "circleci-event-type") ?? (typeof body.type === "string" ? body.type : null)
41
42 // "Test Ping Event" in the webhook settings; confirm the connection quietly.
43 if (event === "ping") {
44 return {
45 title: "🔔 CircleCI connected",
46 message: `Webhook ${text(body.webhook?.name) ? `"${text(body.webhook.name)}" ` : ""}is working`,
47 topic: "CircleCI",
48 priority: -1,
49 }
50 }
51
52 // Guard: only workflow-completed (the header, or the payload's own type field).
53 if (event !== "workflow-completed" || !body.workflow || typeof body.workflow !== "object") {
54 console.log(`Ignoring CircleCI "${event ?? "unknown"}" event`)
55 return null
56 }
57
58 // ?all=1 on the webhook URL also sends quiet pushes for successful and canceled workflows.
59 const all = ["1", "true", "yes"].includes(String(request.query?.all ?? "").toLowerCase())
60 const status = pick(STATUSES, body.workflow.status, null)
61 if (!status || (!status.always && !all)) {
62 console.log(`Skipping workflow status "${body.workflow.status ?? "unknown"}"`)
63 return null
64 }
65
66 // Git details live in pipeline.vcs (GitHub OAuth, Bitbucket) or pipeline.trigger_parameters
67 // (GitLab, GitHub App). Every one of them is optional.
68 const pipeline = body.pipeline ?? {}
69 const vcs = pipeline.vcs ?? {}
70 const params = pipeline.trigger_parameters ?? {}
71 const provider = params.gitlab ?? params.github_app ?? {}
72 const branch = text(vcs.branch) ?? text(params.git?.branch) ?? text(provider.branch)
73 const tag = text(vcs.tag) ?? text(params.git?.tag)
74 const subject = (text(vcs.commit?.subject) ?? text(provider.commit_title) ?? "").split("\n")[0]
75 const author = text(vcs.commit?.author?.name) ?? text(provider.commit_author_name)
76
77 const where = [text(body.project?.name), branch ?? (tag ? `tag ${tag}` : null)].filter(Boolean).join(" · ")
78 const what = subject ? ` — ${subject}` : ""
79 const who = author ? ` (${author})` : ""
80
81 return {
82 title: `${status.emoji} ${text(body.workflow.name) ?? "Workflow"} ${status.verb}`,
83 message: (where || "A CircleCI project") + what + who,
84 topic: "CircleCI",
85 priority: status.priority,
86 buttons: link(body.workflow.url, "View workflow"),
87 }
88}
The CircleCI workflow-completed webhook
This is what CircleCI sends to your URL for workflow completed. It is a sample, trimmed to the fields recipes use.
workflow-completed · sample.json
1{
2 "id": "3888f21b-eaa7-38e3-8f3d-75a63bba8895",
3 "type": "workflow-completed",
4 "project": {
5 "id": "84996744-a854-4f5e-aea3-04e2851dc1d2",
6 "name": "web",
7 "slug": "github/acme/web"
8 },
9 "webhook": {
10 "id": "cf8c4fdd-0587-4da1-b4ca-4846e9640af9",
11 "name": "JustPush"
12 },
13 "pipeline": {
14 "id": "1285fe1d-d3a6-44fc-8886-8979558254c4",
15 "vcs": {
16 "branch": "main",
17 "commit": {
18 "body": "Closes #88",
19 "author": {
20 "name": "Jane Doe",
22 },
23 "subject": "Fix checkout totals rounding",
24 "committer": {
25 "name": "Jane Doe",
27 },
28 "authored_at": "2026-09-24T22:48:53Z",
29 "committed_at": "2026-09-24T22:48:53Z"
30 },
31 "revision": "1dc6aa69429bff4806ad6afe58d3d8f57e25973e",
32 "provider_name": "github",
33 "origin_repository_url": "https://github.com/acme/web",
34 "target_repository_url": "https://github.com/acme/web"
35 },
36 "number": 130,
37 "trigger": {
38 "type": "webhook"
39 },
40 "created_at": "2026-09-24T22:49:03.544Z"
41 },
42 "workflow": {
43 "id": "fda08377-fe7e-46b1-8992-3a7aaecac9c3",
44 "url": "https://app.circleci.com/pipelines/github/acme/web/130/workflows/fda08377-fe7e-46b1-8992-3a7aaecac9c3",
45 "name": "build-test-deploy",
46 "status": "failed",
47 "created_at": "2026-09-24T22:49:03.616Z",
48 "stopped_at": "2026-09-24T22:49:34.170Z"
49 },
50 "happened_at": "2026-09-24T22:49:34.317Z",
51 "organization": {
52 "id": "f22b6566-597d-46d5-ba74-99ef5bb3d85c",
53 "name": "acme"
54 }
55}
CircleCI workflow completed notifications: questions
Does this work on iPhone and Android?
Yes. Install the JustPush app from the App Store or Google Play and sign in. Every phone signed in to your account gets the notification.
Do I need to write code?
No. Install the recipe in Studio, paste your webhook URL into CircleCI and you are done. The code is there if you want to change the text, the sound or the buttons.
Can I change what the notification says?
Yes. After install the recipe's code is yours. Edit it in Studio and test it against the sample payload before you save.
What does it cost?
JustPush is free for 30 days. After that it's $19.99 a year, or $39.99 once. There is no extra charge for recipes.
Ready when you are
CircleCI on your phone in two minutes.
Install the recipe, paste one URL, done. Free for 30 days, no credit card required.