Update Hook | v0 Docs

PATCH/v1/hooks/{hookId}

Usage

TypeScript Example

import { v0 } from 'v0-sdk'

const result = await v0.hooks.update({
  hookId: '123',
  name: 'My Updated Hook',
  events: ['chat.created', 'message.created'],
})

console.log(result)

API Signature

Request

Path Parameters

hookId: string

The ID of the webhook to update. Provided as a path parameter.

Body

name?: string

A new name for the hook.

Updated list of event types to subscribe to.

url?: string

A new URL to send webhook payloads to.

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.

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.