toggl-webhook/dist/api/v1/types.d.ts

Wrapper for toggl webhook api v1

export interface TogglWebhookClientOptions {
    readonly apiToken: string;
    readonly userAgent?: string;
}
export declare type EventAction = 'created' | 'updated' | 'deleted';
export declare type EventFilter = {
    entity: string;
    action: '*' | EventAction;
};
export interface ListEventFiltersResponse {
    [key: string]: EventAction[];
}
export interface ListSubscriptionEventsResponse {
    total: number;
    events: SubscriptionEvent[];
}
export interface PingSubscriptionResponse {
    status: string;
}
export interface ServerStatusResponse {
    status: string;
}
export interface Subscription {
    subscription_id: number;
    workspace_id: number;
    user_id: number;
    enabled: boolean;
    description: string;
    event_filters: EventFilter[];
    url_callback: string;
    secret: string;
    validated_at: null | string;
    has_pending_events: boolean;
    created_at: string;
    updated_at?: string;
    deleted_at?: string;
}
export interface SubscriptionEvent {
    event_id: number;
    created_at: string;
    creator_id: number;
    metadata: SubscriptionEventMetadata;
    payload: Record<string, unknown>;
    consumer_id: number;
    last_delivery_attempt: null | string;
    last_delivery_error: null | string;
    failed_delivery_attempts: number;
}
export interface SubscriptionEventMetadata {
    action: EventAction;
    event_user_id: string;
    model: string;
    path: string;
    request_type: string;
    [key: string]: string;
}