Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weblate hooks API

Notification hooks allow external applications to notify Weblate that the VCS repository has been updated.You can use repository endpoints for projects, components and translations to update individual repositories.

Weblate hooks API is one of 21 APIs that Weblate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include hooks. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 23 schemas. It is described by OpenAPI 3.1.1.

Requests are made against a single base URL, http:.

1 operations 1 paths 23 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
Base URL
https://hosted.weblate.org/api/
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Weblate hooks API declares 3 security schemes for authenticating requests. An API key is passed in the header as Bearer (bearerAuth). An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Token (tokenAuth).

  • bearerAuth — Token-based authentication with required prefix Bearer. - Each user has a personal access token which they can get from their respective user profile. These to…
  • cookieAuth — Session-based authentication used when user is signed in.
  • tokenAuth — Token-based authentication with required prefix Token. - Each user has a personal access token which they can get from their respective user profile. These tok…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

hooks 1

Notification hooks allow external applications to notify Weblate that the VCS repository has been updated. You can use repository endpoints for projects, components and translatio…

POST
/hooks/{service}/
Process incoming webhook from a code hosting site.
hooks_incoming 1 param → 400404405406423500200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are HookResponse (4 properties), Error405 (3 properties), Error406 (3 properties), HookMatch (3 properties). Each schema is shown below with its type and property counts.

ErrorCode406Enum
string
notacceptable - Not Acceptable
Error423
object
3 properties 3 required
ErrorResponse404
object
2 properties 2 required
HookMatch
object
3 properties 3 required
Error406
object
3 properties 3 required
Error405
object
3 properties 3 required
Error400
object
3 properties 3 required
ErrorResponse400TypeEnum
string
validationerror - Validation Error clienterror - Client Error
HookResponse
object
4 properties 3 required
Error500
object
3 properties 3 required
ErrorCode500Enum
string
error - Error
ServerErrorEnum
string
servererror - Server Error
Error404
object
3 properties 3 required
ErrorCode404Enum
string
notfound - Not Found
ErrorResponse500
object
2 properties 2 required
ErrorResponse423
object
2 properties 2 required
ErrorCode423Enum
string
repository-locked - Repository Locked component-locked - Component Locked unknown-locked - Unknown Locked
ErrorResponse400
object
2 properties 2 required
StatusEnum
string
success - success failure - failure
ErrorResponse406
object
2 properties 2 required
ErrorResponse405
object
2 properties 2 required
ErrorCode405Enum
string
methodnotallowed - Method Not Allowed
ClientErrorEnum
string
clienterror - Client Error

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weblate-hooks-api-openapi.yml Raw ↑

Other APIs Weblate publishes across the network.

Weblate addons API
Weblate categories API
Weblate changes API
Weblate component-lists API
Weblate components API
Weblate contributions API
Weblate groups API
Weblate languages API
Weblate memory API
Weblate metrics API
Weblate projects API
Weblate roles API