Aller au contenu
Livstick Développeurs

List webhook deliveries

Méthode GET https://<client-api-host>/api/v3.1/webhooks/deliveries

Journal of the outgoing webhook deliveries of the key's platform, newest first. Bodies and detailed errors are not returned. Use it to catch up after an outage of your receiver; replay is done from the Livstick portal.

Autorisation

Scope requis webhooks:read

Use Authorization: Bearer liv_<prefix>_<secret>. The key must belong to a platform served by the V3 pipeline; otherwise every route answers 403 PLATFORM_NOT_V3.

Paramètres

Nom Emplacement Type Requis Contraintes Description
eventType Paramètre de requête string Facultatif
state Paramètre de requête string Facultatif Valeurs pending done failed skipped
crid Paramètre de requête string Facultatif
mrid Paramètre de requête string Facultatif
limit Paramètre de requête integer Facultatif min 1, max 100 Par défaut 50
skip Paramètre de requête integer Facultatif min 0 Par défaut 0

Réponses

200 application/json Schéma V31WebhookDeliveryList

Paginated list of deliveries.

400 application/json Schéma V31ErrorEnvelope

Invalid payload, unknown field or invalid value.

json 400
{
  "error": {
    "code": "DATA_INVALID",
    "message": "Invalid field crid"
  }
}

401 application/json Schéma V31ErrorEnvelope

Authentication failed or missing bearer token.

json 401
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing API key"
  }
}

403 application/json Schéma V31ErrorEnvelope

Authenticated but not allowed: missing scope (FORBIDDEN), invalid platform constraints (INVALID_PLATFORM_CONSTRAINTS) or a platform not served by API v3.1 (PLATFORM_NOT_V3).

json 403
{
  "error": {
    "code": "PLATFORM_NOT_V3",
    "message": "Platform is not served by API v3.1"
  }
}

429 application/json Schéma V31ErrorEnvelope

Rate limit exceeded.

json 429
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests"
  }
}

500 application/json Schéma V31ErrorEnvelope

Unexpected server error.

json 500
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}