Skip to main content
POST
Store a redacted customer-agent feedback report

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128

Body

application/json
organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
kind
enum<string>
required
Available options:
bug,
issue,
feature_request
title
string
required

Trimmed title without control characters.

Required string length: 1 - 160
description
string
required

Trimmed, redacted expected/actual behavior and minimal reproduction. Line breaks and tabs are accepted; other control characters are rejected. Never include raw logs, environment files, credentials or personal records.

Required string length: 1 - 8000
project_id
string
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
environment_id
string
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
operation_id
string
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
error_code
string
Maximum string length: 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:/+-]{0,127}$
client_version
string
Maximum string length: 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:/+-]{0,127}$

Response

The original durable receipt, including on exact replay.

id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
submitted_at
string<date-time>
required