openWa / src /modules /webhook /dto /webhook.dto.ts
harsh
Deploy: Initial commit without binaries
525d39f
Raw History Blame Contribute Delete
2.63 kB
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import { IsString, IsUrl, IsArray, IsOptional, IsBoolean, IsInt, Min, Max, ArrayMinSize } from 'class-validator';
export const WEBHOOK_EVENTS = [
'message.received',
'message.sent',
'message.ack',
'message.failed',
'message.revoked',
'session.status',
'session.qr',
'session.authenticated',
'session.disconnected',
'group.join',
'group.leave',
'group.update',
] as const;
export type WebhookEventType = (typeof WEBHOOK_EVENTS)[number];
export class CreateWebhookDto {
@ApiProperty({
description: 'Webhook URL to receive events',
example: 'https://your-server.com/webhook',
})
@IsUrl()
url: string;
@ApiPropertyOptional({
description: 'Event types to subscribe to',
example: ['message.received', 'session.status'],
enum: WEBHOOK_EVENTS,
})
@IsOptional()
@IsArray()
@ArrayMinSize(1)
events?: string[];
@ApiPropertyOptional({
description: 'Secret key for HMAC signature verification',
example: 'your-secret-key',
})
@IsOptional()
@IsString()
secret?: string;
@ApiPropertyOptional({
description: 'Custom headers to include in webhook requests',
example: { 'X-Custom-Header': 'value' },
})
@IsOptional()
headers?: Record<string, string>;
@ApiPropertyOptional({
description: 'Number of retry attempts on failure',
example: 3,
minimum: 0,
maximum: 5,
})
@IsOptional()
@IsInt()
@Min(0)
@Max(5)
retryCount?: number;
}
export class UpdateWebhookDto {
@ApiPropertyOptional({ description: 'Webhook URL' })
@IsOptional()
@IsUrl()
url?: string;
@ApiPropertyOptional({ description: 'Event types to subscribe to' })
@IsOptional()
@IsArray()
events?: string[];
@ApiPropertyOptional({ description: 'Secret key for HMAC signature' })
@IsOptional()
@IsString()
secret?: string;
@ApiPropertyOptional({ description: 'Custom headers' })
@IsOptional()
headers?: Record<string, string>;
@ApiPropertyOptional({ description: 'Enable/disable webhook' })
@IsOptional()
@IsBoolean()
active?: boolean;
@ApiPropertyOptional({ description: 'Retry count' })
@IsOptional()
@IsInt()
@Min(0)
@Max(5)
retryCount?: number;
}
export class WebhookResponseDto {
@ApiProperty()
id: string;
@ApiProperty()
sessionId: string;
@ApiProperty()
url: string;
@ApiProperty()
events: string[];
@ApiProperty()
active: boolean;
@ApiProperty()
retryCount: number;
@ApiPropertyOptional()
lastTriggeredAt?: Date | null;
@ApiProperty()
createdAt: Date;
@ApiProperty()
updatedAt: Date;
}