Webhooks

Create Webhook

Register an account-wide webhook. When any interview in your account is completed, a POST request is sent to your hook_url containing the completed interview in the public API shape — study_id, the participant, status, quality, messages, recording links, and screener responses (the same shape returned by GET /interviews/{interview_id}).

Webhooks are not scoped to a single study — you do not pass a study_id. The response includes a signing_secret (shown once): every delivery is signed with it via an X-UI-Signature header (HMAC-SHA256 of "<X-UI-Timestamp>.<body>"), so your endpoint can verify the request is genuine. See Webhooks for the full payload schema, signature verification, and delivery behavior.

POST

api

public

webhooks

Create Webhook

curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/webhooks/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hook_url": "<string>"
}
'

{
  "id": "<string>",
  "hook_url": "<string>",
  "signing_secret": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Body

application/json

hook_url

string

required

Webhook URL to receive completed-interview data for every study in your account

Response

Successful Response

string

required

hook_url

string

required

signing_secret

string | null

HMAC secret for verifying delivery signatures. Returned once, at creation — store it securely; it is never shown again.

created_at

string<date-time> | null

updated_at

string<date-time> | null

Delete WebhookRemove a previously registered webhook. Provide the `hook_url` that was used when the webhook was created. After deletion, completed interviews no longer send requests to that URL. See [Webhooks](/api-reference/webhooks/overview) for details.

Create Webhook

curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/webhooks/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hook_url": "<string>"
}
'

{
  "id": "<string>",
  "hook_url": "<string>",
  "signing_secret": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}