Webhooks

Get one event's catalog entry

One event's catalog entry, including its representative payload.

GET
/v1/webhooks/events/{event}/sample

One event's catalog entry, including its representative payload.

Authorization

deployToken
headerAuthorizationBearer <token>

A project deploy token, minted in the console under Settings, Developer, API tokens. Send the whole value, including the numeric prefix before the |. A token carries a set of abilities (push, pull, manage, read, write) and each operation requires one of them. Tokens do not inherit from each other: a manage token cannot read the glossary unless it also has read.

Path Parameters

event*string
Value in"batch.completed""batch.failed""key.created""key.updated""key.deleted""translation.updated""translation.reviewed""language.added""language.removed""glossary.updated""qa.completed""source_drift.repaired"

Response Body

The catalog entry.

application/json
  1. response
event?WebhookEventName
Value in"batch.completed""batch.failed""key.created""key.updated""key.deleted""translation.updated""translation.reviewed""language.added""language.removed""glossary.updated""qa.completed""source_drift.repaired"
label?string
description?string
coalesced?boolean

true when occurrences are counted over a window and delivered once, carrying count and up to 20 samples, instead of once per occurrence.

window_seconds?integer

The coalescing window; 0 for an event delivered once per occurrence.

samples?string

What the samples array contains, for example key names; empty for a discrete event.

payload?

A representative payload.

curl -X GET 'https://api.transglot.ai/v1/webhooks/events/batch.completed/sample'
{  "event": "key.created",  "label": "Keys created",  "description": "One or more translation keys were created (web CRUD or an API source push).",  "coalesced": true,  "window_seconds": 30,  "samples": "key names",  "payload": {    "event": "key.created",    "delivered_at": "2026-07-08T09:41:00+00:00",    "project": {      "id": 12,      "slug": "acme-web"    },    "count": 37,    "samples": [      "checkout.submit",      "checkout.error.declined"    ],    "window_seconds": 30  }}