Home
v0 Platform API/API Reference/Hooks

Get Hook

Retrieves the details of a specific webhook using its ID.

GET/v1/hooks/{hookId}

Usage

TypeScript Example
import { v0 } from 'v0-sdk'

const result = await v0.hooks.getById({
  hookId: '123',
})

console.log(result)

API Signature

Request

Path Parameters

hookId: string

The unique identifier of the hook to retrieve.

Response

id: string

A unique identifier for the webhook.

object: 'hook'

Fixed value identifying this object as a webhook.

name: string

A user-defined name to label the webhook.

events: 'chat.created' | 'chat.updated' | 'chat.deleted' | 'message.created' | 'message.updated' | 'message.deleted' | 'message.finished'[]

List of event types this webhook is subscribed to.

chatId?: string

Optional ID of the chat that this webhook is scoped to.

url: string

Target URL that receives event payloads for this webhook.

Create Hook

Creates a new webhook that listens for specific events. Supports optional association with a chat.

Update Hook

Updates the configuration of an existing webhook, including its name, event subscriptions, or target URL.