cng-webhooks

name

cng-webhooks

description

How to receive and handle Connect&GO (cng) webhooks in a starter-kit app — today that means the platform-agnostic install-status webhook (install/uninstall lifecycle), NOT booking/waiver parsers (those are peek-only). Use when adding or changing the endpoint that reacts to an app being installed/uninstalled on cng, or any future cng event. Covers verifying + parsing the delivery with parseInstallWebhook (it verifies the signed app_registry_v2 JWT and merges the JSON body into a flat InstallWebhook), what identity to persist (accountId/partnerId is permanent, installId may change, persist platform + accountName) and how permanent each is, idempotency/installDataId scoping, and acting on an event via an install-scoped cng client. Triggers on "cng webhook", "install-status", "parseInstallWebhook", "install/uninstall event", "app_registry_webhook", "react to a cng install".

Connect&GO (cng) webhooks — receiving events

This is the concrete cng inbound path. The generic model — verify the delivery yourself, be idempotent, and "events carry state, not change" — lives in webhooks. Read that for the why; don't re-derive idempotency here. This skill is the authoritative how cng delivers events.

Webhooks are cng → your endpoint, "something happened." This is a different auth model from the API pipeline — here you verify the delivery came from the platform; there is no per-request peek-auth user token to trust (contrast cng-embed-and-auth).

What's available today: the install-status webhook (and NOT booking/waiver parsers)

Load-bearing difference from Peek: the package ships webhook parsers — parseBookingWebhook / parseWaiverWebhook — but those are Peek-only (Peek bookings/waivers). There are no cng-specific event parsers in the SDK. Don't reach for parseBookingWebhook on cng; it doesn't model cng data.

What cng apps in this starter kit do receive is the install-status webhook — a platform-agnostic lifecycle event (install / uninstall / etc.) that Peek's app registry POSTs. It's declared in app.cng.json as the app_registry_webhook@v1 registry extendable pointing at /examples/webhooks/install-status, and implemented at app/examples/webhooks/install-status/route.ts. This same endpoint serves every platform — the account.platform field on the payload tells you which one fired it.

Unlike booking/waiver, the install lifecycle does have a package helper, and it is platform-agnostic (not Peek-only): parseInstallWebhook(token, body, secret) verifies the signed token and merges it with the JSON body into one flat InstallWebhook (installId, accountId — a.k.a. the partner id — accountName, platform, timezone, apiUrl, isTest, status, displayVersion, user). Use it rather than hand-parsing — see javascript-app-utilities.

Not yet fully handled. The shipped endpoint verifies + logs the delivery; real handling ("do X on install/uninstall") is left to you.

Verifying + parsing the delivery — parseInstallWebhook

The install delivery carries two payloads at once: a signed app_registry_v2 JWT (in the x-peek-auth header) and a plain JSON body. parseInstallWebhook(token, body, secret) verifies the token (signature, app_registry_v2 issuer, Joken audience, expiry — pass the app's PEEK_APP_SECRET) and merges it with the body, so you no longer hand-roll JWT verification. It throws on verification failure → one try/catch → 401. It also tolerates the user: null that system-initiated install events carry.

// app/examples/webhooks/install-status/route.ts
import { parseInstallWebhook, type InstallWebhook } from "@peektravel/app-utilities";
import { parseEnv } from "@/lib/env";

export async function POST(request: NextRequest): Promise<NextResponse> {
  const header = request.headers.get("x-peek-auth");
  const token = header?.startsWith("Bearer ") ? header.slice(7) : header ?? "";

  let event: InstallWebhook;
  try {
    event = parseInstallWebhook(token, await request.text(), parseEnv().PEEK_APP_SECRET);
  } catch {
    return NextResponse.json({ error: "Unauthorized" }, { status: 401 }); // bad/forged token
  }
  // ... react to event.status for event.platform === "cng"
  return NextResponse.json({ :  });
}

Version note. Earlier package versions split the install webhook across parseInstallEvent (removed in 0.7.0) and verifyInstallWebhook (deprecated); parseInstallWebhook supersedes both — verifying and merging in one call. If you're on an older scaffold that hand-rolled JWT verification in a lib/webhook-auth.ts, that helper is no longer needed — parseInstallWebhook verifies for you.

The payload — the body is the event, the token authenticates it

A valid token authenticates the whole delivery, so the JSON body is the source of the event data and is trusted within the verified request; the token backs up installId / accountId / status / displayVersion / user when the body omits them. The exact wire shapes (token claims + body JSON, including api.url, account.timezone, modified_by) are in webhooks.

• No payload query to register (unlike Peek's booking webhook, whose payload is shaped by a registered field selection). The shape is fixed by the registry.
• accountId (the partner id) is the permanent anchor for account-scoped data; installId identifies a specific install and may change — don't treat it as an immortal key (full model in webhooks / cng-backoffice-api).
• Persist apiUrl — the per-install back-office endpoint (api.url). Build this install's CngAccessService against it (as given), never a hardcoded URL; it can change on an update_installed, so refresh it every event.
• Persist platform — it selects the access service (cng vs peek vs acme) on this shared endpoint — plus timezone (the account's own zone) and accountName (debugging).
• isTest flags a test/sandbox account — you may want to skip or branch on it.
• installId/accountId/accountName/platform/isTest always arrive → non-nullable columns; apiUrl/timezone may be "" on a delivery, so keep the last stored value.

Endpoint rules

• Verify before trusting the delivery — parseInstallWebhook throws unless the token's signature, issuer, audience, and expiry all check out; a try/catch → 401 is your gate.
• Acknowledge fast, process safely, be idempotent — assume at-least-once delivery (generic discipline in webhooks). Install/uninstall can be redelivered; make handling repeat-safe.
• Every event is a full snapshot — upsert by installId. Install-status is the natural place to hang lifecycle handling: on install/update, upsert the install/account record (capturing accountId, accountName, platform, timezone, and apiUrl — always the latest) and stamp a fresh installDataId; on uninstall, tear down / wipe the prior install's data. Key account-permanent data on accountId; scope wipe-on-reinstall working data to the installDataId you mint (see cng-backoffice-api). Fail loud on an unknown status — a 2xx is treated as delivered and not redelivered, so a coerced unknown drops the transition.
• To act on an event (call cng in response), build an install-scoped client from the stored platform + apiUrl — createAccessServiceForInstall({ platform, apiUrl, installId }, config), or createCngServiceForInstall(installId, apiUrl) (see the server-to-cng recipe in cng-embed-and-auth). Use the install's own apiUrl, not a hardcoded endpoint. Do not use the user-token pipeline — there is no user here.

Future cng events

If cng later ships event-specific parsers or additional webhooks, they'll appear in the installed package (types + docs/webhooks.md) — introspect it (javascript-app-utilities) and pull the live doc; don't hand-write or assume a parser that isn't there. Today, install-status is the only cng-relevant webhook, and you verify + parse it with parseInstallWebhook.

Related skills

• webhooks (global) — the generic delivery-verification / idempotency / "state not change" model behind this skill (don't re-explain it here).
• cng-embed-and-auth — the other inbound path (peek-auth token API), and the createCngServiceForInstall recipe to act on an event with no user token.
• cng-backoffice-api — installDataId scoping and the cng client used inside a handler.
• javascript-nextjs (stack) — the route-handler rules (JSON only, no react-dom/server).
• cng-manifest-and-deploy — where the webhook endpoint URL (app_registry_webhook@v1) is declared in app.cng.json.
• peek-webhooks — Peek's richer webhook story (booking/waiver parsers); a contrast, since those parsers do not apply to cng.