Skip to content
Livstick Developers
v3 Request access

Webhooks

Webhooks let a client platform push an unlock event back into a container's history. Like retarget, this call exists only in API 2.1 — v3 has no equivalent, which is the second of the two reasons an integration stays on 2.1 rather than moving to v3.

API 2.1 Base URL {API_BASE}/v2.1 — the base URL is provided with your access OpenAPI specification

Webhooks

Method POST /v2.1/client/{key}/{crid}/webhook/{webhookId}

Scope client_v2

Push an unlock event for a container. messageUnlockEvent is the only accepted webhookId.

Parameters

Name In Type Required Description
key Path string Required Your 2.1 client API key.
crid Path string Required The container's crid.
webhookId Path string Required The webhook being called. messageUnlockEvent is the only value the enumeration accepts — there is no catalogue of webhooks beyond this one.

Response

json 200 OK 
{
  "status": 1,
  "error": "processed"
}

Notes

  • This success response carries status: 1 and an error field reading "processed" — everywhere else in 2.1, status: 1 marks a failed call. Do not branch on status alone for this operation; check the error value, or you will write an integration test that treats this success as a failure.
  • An unknown webhookId returns the webhook_not_found error code.