VEvercel
Webhooks

Get Webhook

Changed on

Retrieves the details of a specific webhook using its ID.

get/hooks/{hookId}

Request

  • Base URL
    https://api.v0.dev/v2
  • URL
    https://api.v0.dev/v2/hooks/{hookId}
  • Auth
    HTTP bearer

Path parameters

hookIdstring required

The unique identifier of the webhook to retrieve.

Response

Response for status 200

idstring required

A unique identifier for the webhook.

createdAtstring date-time required

The ISO timestamp representing when the chat was created.

namestring required

A user-defined name to label the webhook.

eventsstring[] required

List of event types this webhook is subscribed to.

urlstring required

Target URL that receives event payloads for this webhook.

chatIdstring nullable required

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

Changes

  • da68370a2aeaRevision changes
    • breaking

      for the path request parameter hookId, the minLength was increased from 0 to 1

    • breaking

      response property chatId list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      api operation id hooks.getById removed and replaced with webhooks.get

    • info

      the endpoint scheme security apiKey was removed from the API

    • info

      api tag Webhooks added

    • info

      api tag hooks removed

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 9924b1bf0d99Revision changes
    • warning

      added the new message.finished enum value to the / response property for the response status