Skip to content
Keliplay Docs

List webhook deliveries

GET
/v1/tenant/webhooks/deliveries
curl --request GET \
  --url 'https://api.keliplay.com/v1/tenant/webhooks/deliveries?limit=200&offset=0&sort=createdAt&dir=asc&status=pending' \
  --header 'Authorization: Bearer <token>'

Lists every delivery attempt record across your endpoints, newest first, with the payload that was sent.

Permission: settings.read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 200 >= 1 <= 200

Items per page.

offset
integer
0

Items to skip before the page starts.

search
string
<= 200 characters

Match part of an event type, ignoring case.

sort
string
default: createdAt
Allowed values: createdAt eventType attemptCount

Field to sort by.

dir
string
default: desc
Allowed values: asc desc

Sort direction.

status
string
Allowed values: pending success failed exhausted

Only deliveries in this state.

Responses

Section titled “Responses”

200

Section titled “200”

A page of deliveries.

Media typeapplication/json
object
deliveries
required
Array<object>
object
id
required

The same value as the X-Keliplay-Delivery-Id header.

string
endpointId
required
string
eventType
required
string
Allowed values: session_completed winner_selected reward_granted
payload
required

The body that was sent, { type, createdAt, data }.

object
status
required
  • pending: not tried yet.
  • success: your endpoint answered 2xx.
  • failed: the last try failed and another is scheduled.
  • exhausted: no more tries will be made.
string
Allowed values: pending success failed exhausted
attemptCount
required
integer
lastAttemptedAt
string | null format: date-time
nextRetryAt
string | null format: date-time
responseStatus

The HTTP status your endpoint returned.

integer | null
responseBody

A short note on why a try failed. Your endpoint’s response body is never stored.

string | null
createdAt
required
string format: date-time
total
required
integer
Example
{
  "deliveries": [
    {
      "id": "0192f3a1-0000-7000-8000-0000000b1001",
      "endpointId": "0192f3a1-0000-7000-8000-0000000b0001",
      "eventType": "reward_granted",
      "payload": {
        "type": "reward_granted",
        "createdAt": "2026-10-12T14:03:22.000Z",
        "data": {
          "gameInstanceId": "0192f3a1-0000-7000-8000-0000000ca001",
          "grantId": "0192f3a1-0000-7000-8000-000000073001",
          "participantRef": "user_48213",
          "sessionId": "0192f3a1-0000-7000-8000-000000050001",
          "source": "rule",
          "expiresAt": "2026-11-11T14:03:22.000Z"
        }
      },
      "status": "success",
      "attemptCount": 1,
      "lastAttemptedAt": "2026-10-12T14:03:23.000Z",
      "nextRetryAt": null,
      "responseStatus": 200,
      "responseBody": null,
      "createdAt": "2026-10-12T14:03:22.000Z"
    }
  ],
  "total": 1
}

400

Section titled “400”

The request is not valid. details lists each field that failed, where there is one.

Media typeapplication/json
object
error
required
object
code
required

Stable and safe to branch on.

  • invalid_request (400): the request is not valid.
  • unauthorized (401): missing, malformed or revoked API key.
  • upgrade_required (402): not in your plan, or a plan limit is reached.
  • forbidden (403): the key lacks a permission, or the action is not allowed.
  • not_found (404): nothing with that id in your account.
  • conflict (409): clashes with the current state.
  • confirmation_required (409): repeat with confirm=true. Folder deletion only.
  • rate_limited (429): wait for Retry-After seconds.
  • internal_error (500) and service_unavailable (503): try again later.
string
Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable
message
required

Written for a person. May change; do not parse it.

string
details
One of:
Array<object>
object
path
required

The failing field, dot separated, such as prize.label.

string
message
required
string
Example
{
  "error": {
    "code": "invalid_request",
    "message": "Invalid request json.",
    "details": [
      {
        "path": "name",
        "message": "Too small, expected string to have >=1 characters"
      }
    ]
  }
}

401

Section titled “401”

The API key is missing, malformed or revoked.

Media typeapplication/json
object
error
required
object
code
required

Stable and safe to branch on.

  • invalid_request (400): the request is not valid.
  • unauthorized (401): missing, malformed or revoked API key.
  • upgrade_required (402): not in your plan, or a plan limit is reached.
  • forbidden (403): the key lacks a permission, or the action is not allowed.
  • not_found (404): nothing with that id in your account.
  • conflict (409): clashes with the current state.
  • confirmation_required (409): repeat with confirm=true. Folder deletion only.
  • rate_limited (429): wait for Retry-After seconds.
  • internal_error (500) and service_unavailable (503): try again later.
string
Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable
message
required

Written for a person. May change; do not parse it.

string
details
One of:
Array<object>
object
path
required

The failing field, dot separated, such as prize.label.

string
message
required
string
Example
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or revoked API key."
  }
}

403

Section titled “403”

The API key does not carry the permission this needs, or the request is not allowed.

Media typeapplication/json
object
error
required
object
code
required

Stable and safe to branch on.

  • invalid_request (400): the request is not valid.
  • unauthorized (401): missing, malformed or revoked API key.
  • upgrade_required (402): not in your plan, or a plan limit is reached.
  • forbidden (403): the key lacks a permission, or the action is not allowed.
  • not_found (404): nothing with that id in your account.
  • conflict (409): clashes with the current state.
  • confirmation_required (409): repeat with confirm=true. Folder deletion only.
  • rate_limited (429): wait for Retry-After seconds.
  • internal_error (500) and service_unavailable (503): try again later.
string
Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable
message
required

Written for a person. May change; do not parse it.

string
details
One of:
Array<object>
object
path
required

The failing field, dot separated, such as prize.label.

string
message
required
string
Example
{
  "error": {
    "code": "forbidden",
    "message": "Your role does not allow this (draws.run)."
  }
}

Product tour, pricing and demos: keliplay.com