# Test a webhook endpoint

`POST https://api.lingohub.com/v2/webhook-endpoints/{webhookEndpointId}/test`

LingoHub API V2 (Beta) · [Webhooks](https://developers.lingohub.com/reference/v2/operations/tags/webhooks.md) · operation `testWebhookEndpoint`

Sends a signed `ping` event to this endpoint only, in the background; poll the delivery at the URL in `Location`. The endpoint must be enabled. The ping is an ordinary delivery: it appears in the endpoint's delivery list, is retried like any other, and its failed attempts count toward the 15 in a row that switch the endpoint off. Endpoints can't subscribe to `ping`. Requires workspace-level API access management permission.

## Parameters

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `webhookEndpointId` | path | yes | string |  |
| `Idempotency-Key` | header | no | string | Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained separately for 24 hours by default. There is n… |

## Example request

```sh
curl --request POST \
  --url https://api.lingohub.com/v2/webhook-endpoints/WEBHOOK_ENDPOINT_ID/test \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Responses

- `202`: The ping is queued; poll the delivery at the URL in `Location`.
- `400`: 
- `401`: 
- `403`: 
- `404`: 
- `409`: The endpoint is not enabled (`conflict`); enable it first. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request…
- `422`: The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).
- `429`: 
- `500`: 
- `503`: 

## OpenAPI definition

The complete definition of this operation, with every schema it references:

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "LingoHub API V2 (Beta)",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.lingohub.com",
      "description": "LingoHub"
    }
  ],
  "tags": [
    {
      "name": "Webhooks",
      "description": "Receive LingoHub events at your own endpoint: manage endpoints and signing secrets, and inspect or redeliver deliveries."
    }
  ],
  "paths": {
    "/v2/webhook-endpoints/{webhookEndpointId}/test": {
      "post": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Test a webhook endpoint",
        "description": "Sends a signed `ping` event to this endpoint only, in the background; poll the delivery at the URL in `Location`. The endpoint must be enabled. The ping is an ordinary delivery: it appears in the endpoint's delivery list, is retried like any other, and its failed attempts count toward the 15 in a row that switch the endpoint off. Endpoints can't subscribe to `ping`. Requires workspace-level API access management permission.",
        "operationId": "testWebhookEndpoint",
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Public id composed of the resource type prefix and its UUID.",
              "pattern": "^whe_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "description": "Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained separately for 24 hours by default. There is no request-wide transaction or atomic commit between the operation and its replay result. A matching cached response is replayed verbatim with `Idempotent-Replayed: true`. Loss or expiry of the retained response can remove protection and allow re-execution. Uploads and chunked bodies are covered; multipart boundaries and JSON property order may differ. Retries still pass validation and current authorization; a later 403/404 does not undo the original operation. A changed payload returns 422 `idempotency_key_mismatch`. A recent active reservation returns 409 `idempotency_key_in_use` with `Retry-After`. A retry with an unresolved key, including an unfinished reservation older than 5 minutes, returns 409 `idempotency_outcome_unknown` without `Retry-After`. This timeout does not release the reservation or permit re-execution while it is retained. Inspect the affected resource before starting a new operation; do not blindly reuse an unresolved key after expiry. A 4xx rejection releases the reservation, allowing the same key to be retried after correcting the cause. A 5xx or interruption after execution starts leaves it unresolved. An unavailable reservation store returns 503 before execution; an oversized request returns 413. Cache-save failure or a response over the cache limit preserves the original success status, headers and body; only future retries become unresolved. When idempotency is explicitly disabled by server configuration, the header is ignored and requests execute normally without retry protection. Use a new unique key for each intended operation.",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 255,
              "minLength": 1
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The ping is queued; poll the delivery at the URL in `Location`.",
            "headers": {
              "RateLimit": {
                "$ref": "#/components/headers/RateLimit"
              },
              "Idempotent-Replayed": {
                "$ref": "#/components/headers/Idempotent-Replayed"
              },
              "RateLimit-Policy": {
                "$ref": "#/components/headers/RateLimit-Policy"
              },
              "Location": {
                "description": "URL of the queued delivery.",
                "style": "simple",
                "schema": {
                  "type": "string",
                  "format": "uri-reference",
                  "example": "/v2/webhook-deliveries/whd_0197c8f2-5a6b-7cde-8f12-3456789abcde"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookDeliveryJob"
                },
                "examples": {
                  "ping": {
                    "summary": "A queued ping",
                    "description": "ping",
                    "value": {
                      "object_type": "JOB",
                      "job_type": "WEBHOOK_DELIVERY",
                      "data": {
                        "object_type": "WEBHOOK_DELIVERY",
                        "id": "whd_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                        "webhook_endpoint_id": "whe_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                        "event_id": "evt_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                        "event_type": "ping",
                        "status": "QUEUED",
                        "is_exhausted": false,
                        "attempt_count": 0,
                        "max_attempts": 8,
                        "next_attempt_at": "2026-09-29T10:00:00.123Z",
                        "last_response_status": null,
                        "last_response_body": null,
                        "last_duration_ms": null,
                        "last_error": null,
                        "delivered_at": null,
                        "created_at": "2026-09-29T10:00:00.123Z",
                        "updated_at": "2026-09-29T10:00:00.123Z",
                        "request": {
                          "url": "https://example.com/lingohub/webhooks",
                          "headers": {
                            "webhook-id": "evt_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                            "content-type": "application/json",
                            "user-agent": "LingoHub-Webhooks/1"
                          },
                          "body": "{\"id\":\"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"type\":\"ping\",\"api_version\":\"2026-07-01\",\"created_at\":\"2026-09-29T10:00:00.123+00:00\",\"workspace_id\":\"space_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"data\":{\"webhook_endpoint_id\":\"whe_0197c8f2-5a6b-7cde-8f12-3456789abcde\"}}"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "The endpoint is not enabled (`conflict`); enable it first. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.",
            "headers": {
              "Retry-After": {
                "description": "Seconds to wait for an in-progress keyed request; absent for other conflicts.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "RateLimit": {
                "$ref": "#/components/headers/RateLimit"
              },
              "RateLimit-Policy": {
                "$ref": "#/components/headers/RateLimit-Policy"
              }
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "422": {
            "description": "The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).",
            "headers": {
              "RateLimit": {
                "$ref": "#/components/headers/RateLimit"
              },
              "RateLimit-Policy": {
                "$ref": "#/components/headers/RateLimit-Policy"
              }
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "headers": {
      "RateLimit": {
        "description": "State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with `r` = requests remaining right now and `t` = seconds until the full quota is available again. Example: `\"api-key\";r=42;t=7`. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.",
        "schema": {
          "type": "string"
        }
      },
      "Idempotent-Replayed": {
        "description": "True when the original successful result was replayed for this key.",
        "schema": {
          "type": "boolean"
        }
      },
      "RateLimit-Policy": {
        "description": "The rate-limit policies applied to the request: each quoted policy name with `q` = sustained request quota per window of `w` seconds. Example: `\"api-key\";q=180;w=60, \"workspace\";q=600;w=60`. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.",
        "schema": {
          "type": "string"
        }
      },
      "Retry-After": {
        "description": "Seconds to wait before retrying.",
        "schema": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "schemas": {
      "WebhookDeliveryJob": {
        "type": "object",
        "description": "A webhook delivery scheduled for asynchronous processing.",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/WebhookDelivery",
            "description": "The queued delivery. Poll the Location while QUEUED or PROCESSING; SUCCEEDED and FAILED are terminal."
          },
          "job_type": {
            "type": "string",
            "description": "Always `WEBHOOK_DELIVERY`.",
            "enum": [
              "WEBHOOK_DELIVERY"
            ],
            "example": "WEBHOOK_DELIVERY"
          },
          "object_type": {
            "type": "string",
            "description": "Always `JOB`.",
            "enum": [
              "JOB"
            ],
            "example": "JOB"
          }
        },
        "required": [
          "data",
          "job_type",
          "object_type"
        ]
      },
      "WebhookDelivery": {
        "type": "object",
        "description": "One event sent to one endpoint: its status, attempts, next retry, the last response, and the request that is sent.",
        "properties": {
          "object_type": {
            "type": "string",
            "description": "Always `WEBHOOK_DELIVERY`.",
            "enum": [
              "WEBHOOK_DELIVERY"
            ],
            "example": "WEBHOOK_DELIVERY"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier of the webhook delivery.",
            "example": "whd_0197c8f2-5a6b-7cde-8f12-3456789abcde",
            "minLength": 1,
            "pattern": "^whd_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
          },
          "webhook_endpoint_id": {
            "type": "string",
            "description": "The endpoint the delivery is sent to.",
            "example": "whe_0197c8f2-5a6b-7cde-8f12-3456789abcde",
            "pattern": "^whe_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
          },
          "event_id": {
            "type": "string",
            "description": "The event that is sent; also the webhook-id header of the request.",
            "example": "evt_0197c8f2-5a6b-7cde-8f12-3456789abcde",
            "pattern": "^evt_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
          },
          "event_type": {
            "type": [
              "string",
              "null"
            ],
            "description": "Public event name; null only for an event type this LingoHub version doesn't know yet.",
            "example": "project.created"
          },
          "status": {
            "$ref": "#/components/schemas/WebhookDeliveryStatus",
            "description": "QUEUED waits for the first attempt or the next retry; PROCESSING is being sent; SUCCEEDED was accepted by the endpoint; FAILED was given up: `is_exhausted` true means all attempts were used, false that it stopped for another reason, e.g. a disabled endpoint.",
            "example": "QUEUED"
          },
          "is_exhausted": {
            "type": "boolean",
            "description": "Whether all attempts were used.",
            "example": false
          },
          "attempt_count": {
            "type": "integer",
            "format": "int32",
            "description": "Attempts made so far.",
            "example": 2
          },
          "max_attempts": {
            "type": "integer",
            "format": "int32",
            "description": "Attempts the delivery gets before it is given up.",
            "example": 8
          },
          "next_attempt_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the next attempt is due; null when none is scheduled.",
            "example": "2026-09-29T10:00:00.123Z"
          },
          "last_response_status": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int32",
            "description": "HTTP status the endpoint answered the last attempt with; null without a response.",
            "example": 503
          },
          "last_response_body": {
            "type": [
              "string",
              "null"
            ],
            "description": "Body of the endpoint's answer to the last failed attempt, cut at 8192 bytes; null when there was none.",
            "example": "Temporarily unavailable"
          },
          "last_duration_ms": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int32",
            "description": "How long the last attempt took, in milliseconds.",
            "example": 120
          },
          "last_error": {
            "type": [
              "string",
              "null"
            ],
            "description": "Short fixed text explaining why the last attempt failed, such as `non-2xx response: 503` or `The endpoint did not respond in time.`; null when no attempt failed.",
            "example": "non-2xx response: 503"
          },
          "delivered_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the endpoint accepted the delivery; null until it has.",
            "example": null
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the delivery was queued.",
            "example": "2026-09-29T10:00:00.123Z"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the delivery last changed.",
            "example": "2026-09-29T10:00:00.123Z"
          },
          "request": {
            "$ref": "#/components/schemas/WebhookRequestDetails",
            "description": "The request that is sent, rebuilt on each read from the event and the endpoint's current URL; the signature headers are not shown."
          }
        },
        "required": [
          "attempt_count",
          "created_at",
          "delivered_at",
          "event_id",
          "event_type",
          "id",
          "is_exhausted",
          "last_duration_ms",
          "last_error",
          "last_response_body",
          "last_response_status",
          "max_attempts",
          "next_attempt_at",
          "object_type",
          "request",
          "status",
          "updated_at",
          "webhook_endpoint_id"
        ]
      },
      "WebhookDeliveryStatus": {
        "type": "string",
        "description": "Public webhook delivery state.",
        "enum": [
          "QUEUED",
          "PROCESSING",
          "SUCCEEDED",
          "FAILED"
        ]
      },
      "WebhookRequestDetails": {
        "type": "object",
        "description": "The request the delivery sends, rebuilt on each read from the event and the endpoint's current URL and payload format. It is not a stored copy of what an earlier attempt sent.",
        "properties": {
          "url": {
            "type": "string",
            "description": "The endpoint's current URL.",
            "example": "https://example.com/lingohub/webhooks"
          },
          "headers": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Headers every attempt sends: webhook-id (the event's id), content-type and user-agent. The webhook-timestamp and webhook-signature headers are made for each attempt and not shown.",
            "example": {
              "webhook-id": "evt_0197c8f2-5a6b-7cde-8f12-3456789abcde",
              "content-type": "application/json",
              "user-agent": "LingoHub-Webhooks/1"
            }
          },
          "body": {
            "type": [
              "string",
              "null"
            ],
            "description": "The JSON body as it is signed and sent; null when this LingoHub version doesn't know the event type yet.",
            "example": "{\"id\":\"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"type\":\"project.created\",\"api_version\":\"2026-07-01\",\"created_at\":\"2026-09-29T10:00:00.123+00:00\",\"workspace_id\":\"space_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"data\":{\"id\":\"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"title\":\"Website\"}}"
          }
        },
        "required": [
          "body",
          "headers",
          "url"
        ]
      },
      "Error": {
        "type": "object",
        "description": "RFC 9457 problem details. `code` identifies the problem type (one per `type` URL); `errors` lists rejected fields or parameters; `required_permission` names the permission a 403 lacked.",
        "properties": {
          "type": {
            "type": "string",
            "description": "URL identifying the problem type and pointing to its documentation.",
            "example": "https://api.lingohub.com/errors/resource-not-found"
          },
          "title": {
            "type": "string",
            "description": "Short, constant summary of the problem type.",
            "example": "Resource not found"
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "description": "HTTP status code.",
            "example": 404
          },
          "detail": {
            "type": "string",
            "description": "Human-readable explanation of this occurrence of the problem.",
            "example": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found."
          },
          "instance": {
            "type": "string",
            "description": "Path of the request that produced the problem.",
            "example": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde"
          },
          "code": {
            "$ref": "#/components/schemas/ErrorCode",
            "description": "Machine-readable problem type.",
            "example": "resource_not_found"
          },
          "request_id": {
            "type": "string",
            "description": "Correlation id of the request, also returned in the `X-Request-ID` header. Quote it when contacting support.",
            "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
          },
          "errors": {
            "type": "array",
            "description": "Rejected fields or parameters. Present when the problem concerns specific fields or parameters.",
            "example": [
              {
                "detail": "must be at least 2 characters long",
                "pointer": "#/name",
                "parameter": "limit",
                "code": "minLength"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/FieldError"
            }
          },
          "required_permission": {
            "$ref": "#/components/schemas/RequiredPermission",
            "description": "The permission the API key lacks. Present on 403 responses."
          }
        },
        "required": [
          "code",
          "detail",
          "instance",
          "request_id",
          "status",
          "title",
          "type"
        ]
      },
      "ErrorCode": {
        "type": "string",
        "description": "Machine-readable problem type of a V2 error response. Each code has a fixed HTTP status and documentation at its `type` URL.",
        "enum": [
          "invalid_json",
          "invalid_parameter",
          "missing_parameter",
          "unknown_parameter",
          "invalid_filter",
          "invalid_cursor",
          "bad_request",
          "missing_api_key",
          "invalid_api_key",
          "expired_api_key",
          "revoked_api_key",
          "disabled_api_key",
          "insufficient_permissions",
          "resource_not_found",
          "route_not_found",
          "method_not_allowed",
          "not_acceptable",
          "precondition_failed",
          "content_too_large",
          "unsupported_media_type",
          "already_exists",
          "idempotency_outcome_unknown",
          "idempotency_key_in_use",
          "stack_not_empty",
          "branch_not_ready",
          "backup_not_ready",
          "backup_in_use",
          "default_branch_protected",
          "owner_membership_protected",
          "source_language_protected",
          "branch_limit_reached",
          "context_image_limit_reached",
          "automation_limit_reached",
          "translation_order_pending",
          "git_integration_not_configured",
          "branch_git_integration_not_configured",
          "git_integration_unauthorized",
          "conflict",
          "validation_failed",
          "idempotency_key_mismatch",
          "rate_limit_exceeded",
          "internal_error",
          "upstream_error",
          "service_unavailable",
          "upstream_timeout"
        ]
      },
      "FieldError": {
        "type": "object",
        "description": "A rejected field or parameter. `pointer` locates a body field (RFC 6901 JSON Pointer), `parameter` a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as `filter`.",
        "properties": {
          "detail": {
            "type": "string",
            "description": "Human-readable description of the problem.",
            "example": "must be at least 2 characters long"
          },
          "pointer": {
            "type": [
              "string",
              "null"
            ],
            "description": "JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.",
            "example": "#/name"
          },
          "parameter": {
            "type": [
              "string",
              "null"
            ],
            "description": "Name of the offending query, path or header parameter, or of the multipart form field.",
            "example": "limit"
          },
          "code": {
            "$ref": "#/components/schemas/FieldErrorCode",
            "description": "Why the field or parameter was rejected.",
            "example": "minLength"
          }
        },
        "required": [
          "code",
          "detail",
          "parameter",
          "pointer"
        ]
      },
      "FieldErrorCode": {
        "type": "string",
        "description": "Why a field or parameter was rejected: the JSON Schema keyword of the violated rule, or one of the documented rules that no schema can express.",
        "enum": [
          "required",
          "type",
          "enum",
          "minLength",
          "maxLength",
          "minimum",
          "maximum",
          "pattern",
          "format",
          "additionalProperties",
          "minItems",
          "maxItems",
          "uniqueItems",
          "already_exists",
          "not_found",
          "not_supported",
          "unsupported_file_extension",
          "file_too_large",
          "file_empty",
          "invalid_archive",
          "empty_archive"
        ]
      },
      "RequiredPermission": {
        "type": "object",
        "description": "The permission the API key lacks, in the vocabulary of the API key permission settings.",
        "properties": {
          "scope": {
            "$ref": "#/components/schemas/PermissionScope",
            "description": "Where the permission applies.",
            "example": "STACK"
          },
          "target": {
            "$ref": "#/components/schemas/PermissionTarget",
            "description": "The area the permission governs.",
            "example": "SETTINGS"
          },
          "level": {
            "$ref": "#/components/schemas/PermissionLevel",
            "description": "The access level required.",
            "example": "MANAGE"
          }
        },
        "required": [
          "level",
          "scope",
          "target"
        ]
      },
      "PermissionScope": {
        "type": "string",
        "description": "Where a permission applies: `WORKSPACE` permissions cover workspace-level resources, `STACK` permissions the resources of a stack (its projects, branches, resources, languages, ...).",
        "enum": [
          "WORKSPACE",
          "STACK"
        ]
      },
      "PermissionTarget": {
        "type": "string",
        "description": "The area a permission governs.",
        "enum": [
          "GENERAL",
          "BILLING_SUBSCRIPTION",
          "WORKSPACES",
          "MEMBERS",
          "PLUGINS_INTEGRATIONS",
          "LOGS",
          "API_ACCESS",
          "STACKS",
          "TRANSLATION_ORDERS",
          "WORK_REPORTS",
          "STYLE_GUIDES",
          "GLOSSARIES",
          "TRANSLATION_MEMORIES",
          "LABELS",
          "AI_TRANSLATION",
          "QUICK_TRANSLATIONS",
          "SETTINGS",
          "ACTIVITIES",
          "RESOURCES",
          "CONTEXT_IMAGES",
          "LANGUAGES",
          "SEGMENT_KEYS",
          "SEGMENTS",
          "SEGMENT_TEXTS"
        ]
      },
      "PermissionLevel": {
        "type": "string",
        "description": "Access level of a permission: `MANAGE` includes `WRITE` and `VIEW`.",
        "enum": [
          "NO_ACCESS",
          "VIEW",
          "WRITE",
          "MANAGE"
        ]
      }
    },
    "responses": {
      "BadRequest": {
        "description": "The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. `code` names the problem, `errors` the parameter or field.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Invalid or missing API key.",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Insufficient permissions.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "NotFound": {
        "description": "The resource does not exist, or the API key cannot see it.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.",
        "headers": {
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "An unexpected internal server error occurred.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "ServiceUnavailable": {
        "description": "The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.",
        "headers": {
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "description": "API key authentication. Create API keys in your LingoHub workspace settings. Keys use the `lh-api_` prefix. Pass the full key as the Bearer token.",
        "scheme": "bearer"
      }
    }
  }
}
````
