curl --request POST \
--url https://clientapi.woku.app/v1/captures \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"targetId": "<string>",
"rating": 3,
"score": 5,
"comment": "<string>",
"respondent": {
"email": "<string>",
"phone": "<string>",
"externalId": "<string>"
}
}
'import requests
url = "https://clientapi.woku.app/v1/captures"
payload = {
"id": "<string>",
"targetId": "<string>",
"rating": 3,
"score": 5,
"comment": "<string>",
"respondent": {
"email": "<string>",
"phone": "<string>",
"externalId": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
targetId: '<string>',
rating: 3,
score: 5,
comment: '<string>',
respondent: {email: '<string>', phone: '<string>', externalId: '<string>'}
})
};
fetch('https://clientapi.woku.app/v1/captures', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://clientapi.woku.app/v1/captures",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'targetId' => '<string>',
'rating' => 3,
'score' => 5,
'comment' => '<string>',
'respondent' => [
'email' => '<string>',
'phone' => '<string>',
'externalId' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://clientapi.woku.app/v1/captures"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"targetId\": \"<string>\",\n \"rating\": 3,\n \"score\": 5,\n \"comment\": \"<string>\",\n \"respondent\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://clientapi.woku.app/v1/captures")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"targetId\": \"<string>\",\n \"rating\": 3,\n \"score\": 5,\n \"comment\": \"<string>\",\n \"respondent\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://clientapi.woku.app/v1/captures")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"targetId\": \"<string>\",\n \"rating\": 3,\n \"score\": 5,\n \"comment\": \"<string>\",\n \"respondent\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"kind": "woku",
"remoteId": "<string>",
"status": "accepted"
}{
"statusCode": 400,
"message": "<string>",
"error": "Bad Request"
}{
"statusCode": 403,
"message": "Authentication required",
"error": "Forbidden"
}Capture a woku review or NPS response (mobile SDK)
Ingestion endpoint for the Woku mobile SDK. Routes by kind: woku creates a woku review, nps an NPS response. The company is resolved from the API key and the response channel is sealed server-side to mobile-sdk. Send application/json for text/rating captures, or multipart/form-data (a file part plus a payload field with the CaptureSubmission JSON) for audio captures, which are stored as voicemail reviews. Idempotent by the submission’s client id (X-Woku-Idempotency-Key header or payload.id): retrying a processed submission returns the same result instead of duplicating it.
curl --request POST \
--url https://clientapi.woku.app/v1/captures \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"targetId": "<string>",
"rating": 3,
"score": 5,
"comment": "<string>",
"respondent": {
"email": "<string>",
"phone": "<string>",
"externalId": "<string>"
}
}
'import requests
url = "https://clientapi.woku.app/v1/captures"
payload = {
"id": "<string>",
"targetId": "<string>",
"rating": 3,
"score": 5,
"comment": "<string>",
"respondent": {
"email": "<string>",
"phone": "<string>",
"externalId": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
targetId: '<string>',
rating: 3,
score: 5,
comment: '<string>',
respondent: {email: '<string>', phone: '<string>', externalId: '<string>'}
})
};
fetch('https://clientapi.woku.app/v1/captures', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://clientapi.woku.app/v1/captures",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'targetId' => '<string>',
'rating' => 3,
'score' => 5,
'comment' => '<string>',
'respondent' => [
'email' => '<string>',
'phone' => '<string>',
'externalId' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://clientapi.woku.app/v1/captures"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"targetId\": \"<string>\",\n \"rating\": 3,\n \"score\": 5,\n \"comment\": \"<string>\",\n \"respondent\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://clientapi.woku.app/v1/captures")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"targetId\": \"<string>\",\n \"rating\": 3,\n \"score\": 5,\n \"comment\": \"<string>\",\n \"respondent\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://clientapi.woku.app/v1/captures")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"targetId\": \"<string>\",\n \"rating\": 3,\n \"score\": 5,\n \"comment\": \"<string>\",\n \"respondent\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"kind": "woku",
"remoteId": "<string>",
"status": "accepted"
}{
"statusCode": 400,
"message": "<string>",
"error": "Bad Request"
}{
"statusCode": 403,
"message": "Authentication required",
"error": "Forbidden"
}Authorizations
Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.
Headers
Client-generated submission id for idempotent retries (falls back to payload.id).
Body
Normalized capture from the Woku mobile SDK. The response channel is sealed server-side to 'mobile-sdk' (it is not read from the body).
woku, nps Client-generated idempotency id
wokuId for a woku capture; optional npsToolId for an NPS capture (company-level when omitted)
Woku star rating (kind=woku)
1 <= x <= 5NPS score (kind=nps)
0 <= x <= 103000Show child attributes
Show child attributes