Management

Create webhook

Changed on

Creates a new webhook for a project. This endpoint requires the write:all scope. If the project cannot be found, a 404 error response is returned.

post/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

Request body

urlstring uri required
subscribedEventsManagementWebhookEvent[] required
rateLimitinteger
additionalHeadersobject
storageUpdatedThrottleSecondsinteger
yDocUpdatedThrottleSecondsinteger

Example request

{
  "url": "https://example.com/webhooks",
  "subscribedEvents": [
    "storageUpdated",
    "userEntered"
  ],
  "rateLimit": 100,
  "storageUpdatedThrottleSeconds": 10,
  "yDocUpdatedThrottleSeconds": 10
}

Response

Success. Returns the created 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

      request body became required

    • breaking

      the request property type changed from number to integer

    • breaking

      the request property type changed from number to integer

    • breaking

      the request property type changed from number to integer

    • breaking

      removed the required property from the response with the status

    • info

      api operation id post-management-webhooks removed and replaced with create-management-webhook

    • 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