Sign in
Management

Get webhook

Changed on

Get one webhook by webhookId for a project. Returns webhook settings such as URL, subscribed events, disabled state, throttling, and additional headers. Returns 404 if the project or webhook does not exist. This endpoint requires the read:all scope.

get/management/projects/{projectId}/webhooks/{webhookId}

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/management/projects/{projectId}/webhooks/{webhookId}
  • Auth: none declared

Path parameters

projectIdstring required

ID of the project

Example:683d49ed6b4d1cec5a597b13
webhookIdstring required

ID of the webhook

Example:wh_abc123

Response

Success. Returns the webhook.

idstring required
createdAtstring date-time required
updatedAtstring date-time required
urlstring uri required
disabledboolean required
rateLimitinteger
subscribedEventsManagementWebhookEvent[] required
additionalHeadersManagementWebhookAdditionalHeaders
storageUpdatedThrottleSecondsinteger required
yDocUpdatedThrottleSecondsinteger required

Example response

{
  "id": "wh_abc123",
  "createdAt": "2024-09-03T12:34:56.000Z",
  "updatedAt": "2024-09-03T12:34:56.000Z",
  "url": "https://example.com/webhooks",
  "disabled": false,
  "subscribedEvents": [
    "storageUpdated",
    "userEntered"
  ],
  "secret": {
    "value": "whsec_abc123"
  },
  "storageUpdatedThrottleSeconds": 10,
  "yDocUpdatedThrottleSeconds": 10
}

Changes

  • 77cd6a75b2b7Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional 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

    • 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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • acf80ed810c3Revision changes
    • info

      endpoint added