Delete Webhook - User Intuition

DELETE

/

api

/

public

/

v1

/

webhooks

/

Delete Webhook

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

Response

Successful Response

Create WebhookRegister 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](/api-reference/webhooks/overview) for the full payload schema, signature verification, and delivery behavior.

Delete Webhook

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}