Management

Delete webhook headers

Changed on

Remove selected additional headers from a webhook. Send header names in headers field; other headers are unchanged. Returns updated headers, or 404 if the project or webhook does not exist. This endpoint requires the write:all scope. At least one header name must be provided; otherwise, a 422 error response is returned.

post/management/projects/{projectId}/webhooks/{webhookId}/delete-additional-headers

Request

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

Path parameters

projectIdstring required

ID of the project

Example:683d49ed6b4d1cec5a597b13
webhookIdstring required

ID of the webhook

Example:wh_abc123

Request body

headersstring[] required

Example request

{
  "headers": [
    "X-Custom-Header",
    "X-Another-Header"
  ]
}

Response

Success. Returns the updated headers.

headersManagementWebhookAdditionalHeaders required

Example response

{
  "headers": {
    "X-Remaining-Header": "value"
  }
}

Changes

  • 77cd6a75b2b7Revision changes
    • breaking

      request body became required

    • breaking

      the request property's minItems was increased to 1

    • info

      api operation id post-management-webhook-headers-delete removed and replaced with delete-management-webhook-additional-headers

  • acf80ed810c3Revision changes
    • info

      endpoint added