BizKitHub Developer Documentation

Parameters

1 path · 1 query · JSON body

Path parameters

· 1

externalIdstringRequired

The 16-char alphanumeric external identifier of the issue.

Length: 16–16

Examplea1B2c3D4e5F6g7H8

Query parameters

· 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json

reasonstringRequired

Reporter's justification. Server rules: trim leading/trailing whitespace, silently truncate at 140 chars, reject as REASON_TOO_SHORT if fewer than 3 non-whitespace chars remain. Passed through an LLM classifier that rejects gibberish, spam, prompt-injection, and emphatic non-justifications ("urgent!!!", "asap") as INVALID_REASON.

Length: 1–500

ExampleProd down since 10 AM, cannot process orders.

customerRealIpstringOptional

Accepted formats:

IPv4 dot-decimal, e.g. 1.1.1.1 (4 octets, 0–255, no leading zeros).
IPv6 as defined by RFC 4291 — full 2001:0db8:0000:0000:0000:0000:0000:0001, zero-compressed 2001:db8::1, IPv4-mapped ::ffff:1.2.3.4, or scoped literals. Both upper- and lower-case hex are accepted.

Server-side canonicalization (ipNormalize in core/src/lib/network/ipNormalize.ts):

Valid IPv4 is passed through verbatim.
Valid IPv6 is lowercased (RFC 5952 §4.3).
IPv4-mapped IPv6 ::ffff:X.X.X.X is unwrapped to plain IPv4 (RFC 4291 §2.5.5.2) so 1.2.3.4 and ::ffff:1.2.3.4 share one brj__geo_ip row.
Loopback aliases (::1, 0.0.0.0, localhost, empty string) collapse to 127.0.0.1.
Junk values that fail both IPv4 and IPv6 validation are silently rejected and replaced with 127.0.0.1 (loopback).

On the wire: every response returns the canonicalized form — clients can safely rely on lowercase IPv6 and the plain-IPv4 unwrap when de-duping or joining. Server-originated writers (activity log, session log, ban list) resolve the visitor IP via resolveClientIp / resolveClientIpOrNull — always native IPv6 on Vercel Edge (there is no auto-mapping to ::ffff:X.X.X.X).

Enrichment: the system resolves reverse DNS, geolocation, ASN, mobile/proxy/hosting/Tor flags via our VikiTron GEO/IP resolver for both address families. Learn more

Examples1.1.1.12001:4860:4860::8888

Response schema

1 status code documented

200Success

object | object

One of 2:

Variant 1

success"true"Required

previousPrioritynumberRequired

Priority BEFORE the escalation (1..5).

newPrioritynumberRequired

Priority AFTER the escalation (1..5). Equal to previousPriority when already at blocker.

changedbooleanRequired

False when the ticket was already at blocker priority — the audit comment is still written.

Variant 2

success"false"Required

messagestringOptional

Human-readable explanation. Present on INVALID_REASON (short blurb from the classifier) and UPSTREAM_ERROR — surface verbatim in the UI.

Response example