curl --request POST \
--url https://app.usertick.com/api/public/v1/webhooks/subscribe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"targetUrl": "https://hooks.example.com/usertick",
"event": "response.analyzed"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({targetUrl: 'https://hooks.example.com/usertick', event: 'response.analyzed'})
};
fetch('https://app.usertick.com/api/public/v1/webhooks/subscribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.usertick.com/api/public/v1/webhooks/subscribe"
payload = {
"targetUrl": "https://hooks.example.com/usertick",
"event": "response.analyzed"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetUrl": "<string>",
"event": "response.created",
"surveyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filters": {
"types": [
"bug"
],
"urgencies": [
"high"
],
"themes": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"secret": "<string>",
"createdAt": "2026-09-30T10:00:00.000Z",
"workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stepId": "<string>"
}Subscribe a URL
A REST hook subscribe: signed deliveries of one event (see webhooks for each one’s body), on one survey or every survey, narrowed by the filters the event takes. Event workflow.step instead binds the URL to a workflow’s Zapier step (workflowId and stepId, from GET /workflows/zapier-steps): the workflow sends a response to it when a run reaches the step, in the body of the event that started the run. One live subscription per step (409 WH-005-010); an app’s member needs the permission to manage workflows. 201 with the whsec_ secret (shown only here); 200 when this credential already subscribed the URL (brought to these settings). Deliveries carry responses, so it needs responses:read too.
Scopes: webhooks:write, responses:read.
curl --request POST \
--url https://app.usertick.com/api/public/v1/webhooks/subscribe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"targetUrl": "https://hooks.example.com/usertick",
"event": "response.analyzed"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({targetUrl: 'https://hooks.example.com/usertick', event: 'response.analyzed'})
};
fetch('https://app.usertick.com/api/public/v1/webhooks/subscribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.usertick.com/api/public/v1/webhooks/subscribe"
payload = {
"targetUrl": "https://hooks.example.com/usertick",
"event": "response.analyzed"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetUrl": "<string>",
"event": "response.created",
"surveyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filters": {
"types": [
"bug"
],
"urgencies": [
"high"
],
"themes": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"secret": "<string>",
"createdAt": "2026-09-30T10:00:00.000Z",
"workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stepId": "<string>"
}Authorizations
An API key (utk_live_...) or an app's OAuth access token (uto_...).
Headers
Any 1 to 255 printable ASCII characters, without a space at either end. The answer to the first request with a key is kept for 24 hours per credential: the same request again gets it back (Idempotent-Replayed: true), another request with the key is 409 PUB-002-002, and while the first still runs 409 PUB-002-003. A server error is not kept, and a request that never answered frees its key after 2 minutes: a retry with the key then runs again.
255Body
8 - 2048response.created, response.analyzed, response.status_changed, response.classification_corrected, response.urgent, theme.spiking, workflow.step What each event takes: response.analyzed, response.status_changed and response.classification_corrected all three; response.urgent types and themes; theme.spiking themes; response.created none (400 APK-006-002 otherwise). A response matches when any answer has one of the types, its urgency is one of the bands, and any answer has one of the themes.
Show child attributes
Show child attributes
workflow.step only, with stepId: the workflow (GET /workflows/zapier-steps lists its Zapier steps).
workflow.step only: the Zapier step's id in the workflow.
32Response
Already subscribed.
response.created, response.analyzed, response.status_changed, response.classification_corrected, response.urgent, theme.spiking, workflow.step What each event takes: response.analyzed, response.status_changed and response.classification_corrected all three; response.urgent types and themes; theme.spiking themes; response.created none (400 APK-006-002 otherwise). A response matches when any answer has one of the types, its urgency is one of the bands, and any answer has one of the themes.
Show child attributes
Show child attributes
The whsec_ signing secret.
"2026-09-30T10:00:00.000Z"
workflow.step only: the workflow whose Zapier step sends to it; null for the other events.
workflow.step only: that step's id in the workflow; null for the other events.