Register an outbound webhook (ULTRA, direct keys only)

We POST the same frames the WebSocket sends to your HTTPS endpoint on every live score commit. Up to 3 webhooks per key (409 webhook_limit past that). The response is the ONLY time the signing secret is shown — store it.

Each delivery carries X-LTAPI-Signature (sha256=<hex> — HMAC-SHA256 of the RAW request body with your webhook secret; verify with a constant-time compare), X-LTAPI-Timestamp (Unix seconds at send time — reject stale replays at your edge) and X-LTAPI-Event (the frame type: score, break_point, break_point_result or point).

Delivery is best-effort, at-most-once, no replay: one attempt per frame with a ~3s timeout and redirects disabled. Every score frame is the complete current score, so a missed delivery self-corrects on the next commit. A point frame is an EVENT, not a state — a missed one does NOT self-correct; recover it with GET /matches/{matchId}/points?after_seq= and dedup by seq. After 25 consecutive failures the webhook is disabled automatically (enabled:false, last_error set — visible in GET /webhooks); delete and re-register to resume.

post/webhooks

Request

  • Base URL: https://api.livetennisapi.com/api/public/v1
  • URL: https://api.livetennisapi.com/api/public/v1/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

urlstring required

HTTPS only, publicly routable

eventsstring[]

score = every accepted live-score commit; break_point = the derived break_point / break_point_result frames; point = one POST per live point (the PointFrame shape), where that surface is enabled and the match has pbp_coverage: "point".

Response

Created — includes secret (shown exactly once)

idinteger
urlstring
eventsstring[]
enabledboolean

Set to false automatically after 25 consecutive delivery failures — delete and re-register to resume.

created_atstring date-time nullable
last_delivery_atstring date-time nullable
consecutive_failuresinteger
last_errorstring nullable
secretstring

Present ONLY on the 201 registration response — shown exactly once

secret_notestring

Changes

No recorded changes to this operation across all 1 revision of this API.