Sign in
Management

Send test webhook

Changed on

Send a test event to a webhook and return the created message metadata. subscribedEvent must be one of the webhook's subscribed events, otherwise the endpoint returns 422. Returns 404 if the project or webhook does not exist. This endpoint requires the write:all scope.

post/management/projects/{projectId}/webhooks/{webhookId}/test

Request

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

Path parameters

projectIdstring required

ID of the project

Example:683d49ed6b4d1cec5a597b13
webhookIdstring required

ID of the webhook

Example:wh_abc123

Request body

subscribedEvent'storageUpdated' | 'userEntered' | 'userLeft' | 'roomCreated' | 'roomDeleted' | 'commentCreated' | 'commentEdited' | 'commentDeleted' | 'commentReactionAdded' | 'commentReactionRemoved' | 'commentMetadataUpdated' | 'threadMetadataUpdated' | 'threadCreated' | 'threadDeleted' | 'ydocUpdated' | 'notification' | 'threadMarkedAsResolved' | 'threadMarkedAsUnresolved' required

Example request

{
  "subscribedEvent": "storageUpdated"
}

Response

Success. Returns the test message ID.

Example response

{
  "message": {
    "id": "msg_abc123",
    "deliveredAt": "2024-09-03T12:34:56.000Z"
  }
}

Changes

  • 77cd6a75b2b7Revision changes
    • breaking

      request body became required

    • breaking

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

    • info

      api operation id post-management-webhook-test removed and replaced with send-test-webhook

  • acf80ed810c3Revision changes
    • info

      endpoint added