Types Reference

Overview

All types are exported from the cuey package. This page provides a complete reference of all available types.

Importing Types

import type {
  Cron,
  Event,
  HttpMethod,
  EventStatus,
  RetryConfig,
  CreateCronInput,
  UpdateCronInput,
  CreateEventInput,
  UpdateEventInput,
  CronsQueryParams,
  EventsQueryParams,
  CueyConfig,
} from "cuey";

Core Types

Cron

Represents a recurring cron job.

interface

Interface representing a cron job.

Show Cron properties

string

required

Unique identifier (UUID).

string

required

Cron expression defining the schedule (e.g., 0 0 * * *).

string | null

Timezone for the cron schedule (e.g., America/New_York). null for UTC.

string

required

Webhook URL that will be called.

HttpMethod

required

HTTP method used for the webhook request.

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.

RetryConfig | null

Retry configuration for failed webhooks. null if not set.

Show RetryConfig properties

number

required

Maximum retry attempts. Range: 1-10.

number

required

Backoff delay in milliseconds. Range: 100-5000.

string

required

Backoff strategy. Values: exponential, linear.

boolean | null

Whether the cron job is active. null defaults to true.

string | null

ISO 8601 timestamp when the cron job was created.

string | null

ISO 8601 timestamp when the cron job was last updated.

string | null

Team ID associated with the cron job.

Event

Represents a scheduled event.

interface

Interface representing a scheduled event.

Show Event properties

string

required

Unique identifier (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. See EventStatus type for possible values.

string

required

Webhook URL that will be called.

HttpMethod

required

HTTP method used for the webhook request.

object | null

Custom headers included in the webhook request. null if not set.

object | null

Payload sent with the webhook request. null if not set.

RetryConfig | null

Retry configuration for failed webhooks. null if not set.

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 1_KB). 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.

HttpMethod

Supported HTTP methods for webhook requests.

union

Union type of supported HTTP methods.

Show HttpMethod values

string

GET request method.

string

POST request method (default).

string

PUT request method.

string

PATCH request method.

string

DELETE request method.

string

HEAD request method.

string

OPTIONS request method.

EventStatus

Status values for event execution.

union

Union type of event status values.

Show EventStatus values

string

Event is scheduled but not yet executed.

string

Event is currently being executed.

string

Event executed successfully.

string

Event execution failed (after all retries).

RetryConfig

Retry configuration for webhooks.

interface

Interface for retry configuration.

Show RetryConfig properties

number

required

Maximum retry attempts. Range: 1-10.

number

required

Backoff delay in milliseconds. Range: 100-5000.

string

required

Backoff strategy. Values: exponential, linear.

Json

JSON type for API payloads.

union

Recursive union type representing any JSON-serializable value.

Show Json values

string

String value.

number

Number value.

boolean

Boolean value.

null

Null value.

object

Object with string keys and Json values.

array

Array of Json values.

Input Types

CreateCronInput

Input for creating a cron job.

interface

Interface for creating a cron job.

Show CreateCronInput properties

string

required

Full URL or relative path of the webhook endpoint.

HttpMethod

HTTP method to use. Defaults to POST.

string

required

Cron expression defining the schedule.

string | null

Timezone for the cron schedule. null for UTC.

Record<string, string> | null

Custom headers to include in the webhook request.

Json | null

Payload to send with the webhook request.

RetryConfig | null

Retry configuration for failed webhooks.

boolean

Whether the cron job should be active immediately. Defaults to true.

UpdateCronInput

Input for updating a cron job (same structure as CreateCronInput).

interface

Interface for updating a cron job. Same structure as CreateCronInput.

CreateEventInput

Input for creating an event.

interface

Interface for creating an event.

Show CreateEventInput properties

string

required

Full URL or relative path of the webhook endpoint.

HttpMethod

HTTP method to use. Defaults to POST.

string

required

ISO 8601 timestamp when the event should execute. Must be in the future.

Record<string, string> | null

Custom headers to include in the webhook request.

Json | null

Payload to send with the webhook request.

RetryConfig | null

Retry configuration for failed webhooks.

UpdateEventInput

Input for updating an event (same structure as CreateEventInput).

interface

Interface for updating an event. Same structure as CreateEventInput.

Query Parameter Types

CronsQueryParams

Query parameters for listing crons.

interface

Interface for query parameters when listing crons.

Show CronsQueryParams properties

number

default:"0"

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

number

default:"100"

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

boolean

Filter by active status. true for active crons, false for inactive crons.

EventsQueryParams

Query parameters for listing events.

interface

Interface for query parameters when listing events.

Show EventsQueryParams properties

number

default:"0"

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

number

default:"100"

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

EventStatus

Filter events by status.

string

Filter events by the cron job that created them.

Configuration Types

CueyConfig

Configuration options for the Cuey client.

interface

Interface for Cuey client configuration.

Show CueyConfig properties

string

Base URL for resolving relative webhook URLs.

string

API key for authentication.

API Response Types

ApiSuccess

Standard API success response.

interface

Generic interface for API success responses.

Show ApiSuccess properties

required

The response data. Type parameter T represents the data type.

ApiSuccessWithPagination

Paginated API success response.

interface

Generic interface for paginated API success responses.

Show ApiSuccessWithPagination properties

T[]

required

Array of response items. Type parameter T represents the item type.

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.

Error Types

See the Error Handling page for complete error type documentation.

class

Base error class for all Cuey API errors. Extends JavaScript’s Error.

union

Union type of all possible error codes.

Show CueyErrorCode values

string

Authentication failed or API key is invalid/missing.

string

Requested resource does not exist.

string

Request is invalid.

string

Request validation failed.

string

Server error occurred.

Type Guards and Utilities

Checking Event Status

function isPending(event: Event): boolean {
  return event.status === "pending";
}

function isSuccess(event: Event): boolean {
  return event.status === "success";
}

function isFailed(event: Event): boolean {
  return event.status === "failed";
}

Type Narrowing

function handleEvent(event: Event) {
  switch (event.status) {
    case "pending":
      // TypeScript knows event.status is "pending"
      console.log("Scheduled for:", event.scheduled_at);
      break;
    case "success":
      // TypeScript knows event.status is "success"
      console.log("Response:", event.response_status);
      break;
    case "failed":
      // TypeScript knows event.status is "failed"
      console.log("Error:", event.response_error);
      break;
  }
}

Type-Safe Payload Handling

interface MyPayload {
  action: string;
  userId: string;
  data: Record<string, unknown>;
}

const cron = await cuey.crons.create({
  webhook_url: "https://api.example.com/webhook",
  cron_expression: "0 0 * * *",
  payload: {
    action: "daily_report",
    userId: "123",
    data: {},
  } satisfies MyPayload,
});

Error Handling

Learn about error types and handling.

Advanced Configuration

Learn about configuration options.

Events

See events resource methods.

Crons

See crons resource methods.

​Overview

​Importing Types

​Core Types

​Cron

​Event

​HttpMethod

​EventStatus

​RetryConfig

​Json

​Input Types

​CreateCronInput

​UpdateCronInput

​CreateEventInput

​UpdateEventInput

​Query Parameter Types

​CronsQueryParams

​EventsQueryParams

​Configuration Types

​CueyConfig

​API Response Types

​ApiSuccess

​ApiSuccessWithPagination

​Error Types

​Type Guards and Utilities

​Checking Event Status

​Type Narrowing

​Type-Safe Payload Handling

​Related Resources

Error Handling

Advanced Configuration

Events

Crons

Overview

Importing Types

Core Types

Cron

Event

HttpMethod

EventStatus

RetryConfig

Json

Input Types

CreateCronInput

UpdateCronInput

CreateEventInput

UpdateEventInput

Query Parameter Types

CronsQueryParams

EventsQueryParams

Configuration Types

CueyConfig

API Response Types

ApiSuccess

ApiSuccessWithPagination

Error Types

Type Guards and Utilities

Checking Event Status

Type Narrowing

Type-Safe Payload Handling

Related Resources