Skip to main content
POST
Capture a woku review or NPS response from the mobile SDK

Authorizations

x-woku-key
string
header
required

Publishable capture key (pk_...), capture endpoints only.

Headers

authorization
string
required
x-woku-idempotency-key
string
required

Body

kind
enum<string>
required
Available options:
woku,
nps,
csat,
ces
Example:

"woku"

dispatchToken
string

Opaque invitation or prepared journey-entry response token. Consumed after saving feedback; never stored on the review.

Maximum string length: 64
id
string

Client-generated idempotency id

language
enum<string>

Spoken language. Required when the capture includes an audio file.

Available options:
es,
en
targetId
string

Target id: the wokuId for a woku capture, the (optional) npsToolId for an NPS capture, or the (required) csatToolId/cesToolId for a CSAT/CES capture (those tools are always custom).

rating
number

Woku star rating 1-5

Example:

5

score
number

NPS score 0-10

Example:

9

comment
string

Free-text comment

Maximum string length: 3000
audio
object
respondent
object

Response

Capture accepted

kind
enum<string>
required
Available options:
woku,
nps,
csat,
ces
status
enum<string>
required
Available options:
accepted
id
string

Client submission id, echoed without replacing the server id.

remoteId
string

Server id of the created feedback resource.