List Events

Overview

List all events with optional pagination and filtering by status or cron ID.

import { cuey } from "cuey";

const { data: events, pagination } = await cuey.events.list();

import { cuey } from "cuey";

const { data: events, pagination } = await cuey.events.list({
  page: 1,
  limit: 50,
});

import { cuey } from "cuey";

const { data: pendingEvents } = await cuey.events.list({
  status: "pending",
});

import { cuey } from "cuey";

const { data: cronEvents } = await cuey.events.list({
  cron_id: "cron-uuid-here",
});

Parameters

number

default:"0"

Page number (0-indexed). Defaults to 0.

number

default:"100"

Number of items per page. Range: 1-1000. Defaults to 100.

string

Filter events by status. Options: pending, processing, success, failed.

string

Filter events by the cron job that created them. Use a valid cron UUID.

Response

Event[]

required

Array of event objects.

Show Event properties

string

required

Unique identifier for the event (UUID).

string | null

Parent cron ID if this event was created by a cron job. null if created manually.

string | null

Original event ID if this is a retry attempt. null for original events.

string

required

ISO 8601 timestamp when the event is scheduled to execute.

string | null

ISO 8601 timestamp when the event was executed. null if not yet executed.

EventStatus

required

Current status of the event. Values: pending, processing, success, failed.

string

required

The webhook URL that will be called.

HttpMethod

required

HTTP method used for the webhook request. Defaults to POST.

object | null

Custom headers to include in the webhook request. null if not set.

object | null

Payload to send with the webhook request. null if not set.

object | null

Retry configuration for failed webhooks.

Show RetryConfig properties

number

required

Maximum number of retry attempts (1-10).

number

required

Backoff delay in milliseconds (100-5000).

string

required

Backoff strategy. Values: exponential, linear.

number | null

HTTP status code from the webhook response. null if not yet executed.

object | null

Response headers from the webhook. null if not yet executed.

string | null

Response body from the webhook (truncated to 1KB). null if not yet executed.

number | null

Duration of the webhook request in milliseconds. null if not yet executed.

string | null

Error message if the webhook execution failed. null if successful or not yet executed.

string | null

ISO 8601 timestamp when the event was created.

string | null

ISO 8601 timestamp when the event was last updated.

string | null

Team ID associated with the event.

object

required

Pagination information.

Show Pagination properties

number

required

Current page number (0-indexed).

number

required

Number of items per page.

number

required

Total number of items across all pages.

{
  "data": [
    {
      "id": "event-uuid-here",
      "cron_id": null,
      "retry_of": null,
      "scheduled_at": "2024-12-31T23:59:59Z",
      "executed_at": null,
      "status": "pending",
      "webhook_url": "https://api.example.com/webhook",
      "method": "POST",
      "headers": null,
      "payload": {
        "message": "Hello, Cuey!"
      },
      "retry_config": null,
      "response_status": null,
      "response_headers": null,
      "response_body": null,
      "response_duration": null,
      "response_error": null,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "team_id": "team-uuid-here"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 100,
    "total": 1
  }
}

Errors

Requesting a page number that is out of range (e.g., page 100 when only 10 pages exist) will throw an InternalServerError.

UnauthorizedError: If API key is invalid or missing
InternalServerError: If the requested page is out of range

Examples

List Pending Events

import { cuey } from "cuey";

const { data: pendingEvents } = await cuey.events.list({
  status: "pending",
});

console.log(`Found ${pendingEvents.length} pending events`);

List Failed Events with Pagination

import { cuey } from "cuey";

const { data: failedEvents, pagination } = await cuey.events.list({
  status: "failed",
  page: 0,
  limit: 50,
});

console.log(`Found ${failedEvents.length} failed events (total: ${pagination.total})`);

List Events Created by a Cron

import { cuey } from "cuey";

const { data: cronEvents } = await cuey.events.list({
  cron_id: "cron-uuid-here",
});

console.log(`Found ${cronEvents.length} events for this cron`);

import { cuey } from "cuey";

const { data: events, pagination } = await cuey.events.list();

import { cuey } from "cuey";

const { data: events, pagination } = await cuey.events.list({
  page: 1,
  limit: 50,
});

import { cuey } from "cuey";

const { data: pendingEvents } = await cuey.events.list({
  status: "pending",
});

import { cuey } from "cuey";

const { data: cronEvents } = await cuey.events.list({
  cron_id: "cron-uuid-here",
});

{
  "data": [
    {
      "id": "event-uuid-here",
      "cron_id": null,
      "retry_of": null,
      "scheduled_at": "2024-12-31T23:59:59Z",
      "executed_at": null,
      "status": "pending",
      "webhook_url": "https://api.example.com/webhook",
      "method": "POST",
      "headers": null,
      "payload": {
        "message": "Hello, Cuey!"
      },
      "retry_config": null,
      "response_status": null,
      "response_headers": null,
      "response_body": null,
      "response_duration": null,
      "response_error": null,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "team_id": "team-uuid-here"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 100,
    "total": 1
  }
}

TypeScript SDK

Advanced

List Events

Overview

Parameters

Response

Errors

Examples

List Pending Events

List Events Created by a Cron

​Overview

​Parameters

​Response

​Errors

​Examples

​List Pending Events

​List Failed Events with Pagination

​List Events Created by a Cron

Overview

Parameters

Response

Errors

Examples

List Pending Events

List Failed Events with Pagination

List Events Created by a Cron