Management

List webhooks

Changed on

Returns a paginated list of webhooks for a project. This endpoint requires the read:all scope. The response includes an array of webhook objects associated with the specified project, as well as a nextCursor property for pagination. Use the limit query parameter to specify the maximum number of webhooks to return (1-100, default 20). If the result is paginated, use the cursor parameter from the nextCursor value in the previous response to fetch subsequent pages. If the project cannot be found, a 404 error response is returned.

get/management/projects/{projectId}/webhooks

Request

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

Path parameters

projectIdstring required

ID of the project

Example:683d49ed6b4d1cec5a597b13

Query parameters

limitinteger

A limit on the number of webhooks to return. The limit can range between 1 and 100, and defaults to 20.

Example:20
cursorstring

A cursor used for pagination. Get the value from the nextCursor response of the previous page.

Example:eyJjcmVhdGVkQXQiOjE2NjAwMDA5ODgxMzd9

Response

Success. Returns the list of webhooks and the next page cursor.

nextCursorstring nullable required

Example response

{
  "data": [
    {
      "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
    }
  ],
  "nextCursor": null
}

Changes

  • 22a5e987b8c9Revision changes
    • info

      the response property became required for the status

  • 77cd6a75b2b7Revision changes
    • breaking

      for the query request parameter limit, the type changed from number to integer

    • breaking

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

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status