Webhook
此页面暂无中文版本,显示的是英文版本。
Preview tenant webhook payloads
Builds the outbound payloads for the given platform, languages and story and returns them WITHOUT sending. Uses the same builder as send, so the preview is 1:1 with what would be delivered. Accessible with WebhookSend + tenant access.
Authorization
BearerAuthObject AuthorizationBearer <token>
Machine tokens only: a personal API token or a product robot token (POST /api/v2/products/{uid}/robot-tokens). A session JWT here is 401 — the web app uses the b2t_access cookie.
In: header
Path Parameters
tenantId*string
Tenant UUID
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/tenants/0c62ac53-56e1-43c1-bdcc-fcc7b9c3c8e9/webhook/preview" \ -H "Content-Type: application/json" \ -d '{ "platform": "web", "languages": [ "en-US", "fr" ], "storyName": "production" }'{ "previews": [ { "language": "en-US", "payload": {} } ]}{ "errors": { "name": "Empty value" }}{ "message": { "error": "Your request was made with invalid credentials." }}{ "message": { "error": "You are not allowed to perform this action." }}{ "message": { "planLimit": "Your Included plan does not include the webhook." }}{ "message": { "error": "Oops! Something went wrong! Write to administrator. Your Request Id {f1177aee-9a99-42f0-a23f-4dd29fc39b65-672e0df972ccb}" }}{ "message": { "error": "Webhooks are temporarily disabled." }}