List webhook endpoints

GET

/v1/tenant/webhooks/endpoints

const url = 'https://api.keliplay.com/v1/tenant/webhooks/endpoints?limit=200&offset=0&sort=createdAt&dir=asc&status=active';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Lists your webhook endpoints. Signing secrets are not included.

Permission: settings.read.

Authorizations

apiKey

Parameters

Query Parameters

limit

integer

default: 200 >= 1 <= 200

Items per page.

offset

integer

Items to skip before the page starts.

search

string

<= 300 characters

Match part of an endpoint URL, ignoring case.

sort

string

default: createdAt

Allowed values: createdAt url

Field to sort by.

dir

string

default: desc

Allowed values: asc desc

Sort direction.

status

string

Allowed values: active disabled

Only active or only disabled endpoints.

Responses

200

A page of endpoints.

application/json

object

endpoints

required

Array<object>

object

required

string

url

required

string format: uri

events

required

Array<string>

Allowed values: session_completed winner_selected reward_granted

gameInstanceIds

required

Only events from these campaigns. Empty with empty channelIds means every campaign.

Array<string>

channelIds

required

Only events from campaigns on these channels.

Array<string>

includeCouponCodes

Whether reward_granted events to this endpoint carry the coupon code.

boolean

status

required

string

Allowed values: active disabled

createdAt

required

string format: date-time

updatedAt

Present on responses that create or change an endpoint.

string format: date-time

total

required

integer

Example

{
  "endpoints": [
    {
      "id": "0192f3a1-0000-7000-8000-0000000b0001",
      "url": "https://hooks.example.com/keliplay",
      "events": [
        "session_completed",
        "reward_granted"
      ],
      "gameInstanceIds": [],
      "channelIds": [
        "0192f3a1-0000-7000-8000-00000000c001"
      ],
      "status": "active",
      "createdAt": "2026-09-01T09:00:00.000Z"
    }
  ],
  "total": 1
}

400

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

application/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

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

The API key is missing, malformed or revoked.

application/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

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

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

application/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

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)."
  }
}