/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { WebhookStatus } from './WebhookStatus'; import type { WebhookSource } from './WebhookSource'; /** * Describes a webhook endpoint that receives event notifications when specified conditions are met, * providing real-time integration capabilities for external systems. * @export * @interface Webhook */ export interface Webhook { /** * * @type {Date} * @memberof Webhook */ readonly createdAt?: Date; /** * * @type {string} * @memberof Webhook */ createdBy?: string; /** * * @type {string} * @memberof Webhook */ endpointUrl?: string; /** * * @type {string} * @memberof Webhook */ readonly failureCount?: string; /** * * @type {string} * @memberof Webhook */ id?: string; /** * The timestamp when the webhook was last successfully delivered to the endpoint. * This field is only updated when the webhook endpoint responds with a 2xx status code. * Use this to track actual successful event notifications to external systems. * @type {Date} * @memberof Webhook */ readonly lastDeliveredAt?: Date; /** * The timestamp when the webhook was last triggered (attempted), regardless of success or failure. * This field is updated on every webhook transmission attempt, including failed deliveries. * Use this to track webhook activity and debugging transmission issues. * @type {Date} * @memberof Webhook */ readonly lastSentAt?: Date; /** * Filter webhook notifications by a specific link ID. * Only events from this link will trigger webhook notifications. * If empty, all links in the workspace will trigger notifications. * @type {string} * @memberof Webhook */ linkId?: string; /** * * @type {string} * @memberof Webhook */ name?: string; /** * * @type {WebhookSource} * @memberof Webhook */ source?: WebhookSource; /** * * @type {WebhookStatus} * @memberof Webhook */ status?: WebhookStatus; /** * * @type {string} * @memberof Webhook */ readonly successCount?: string; /** * Filter webhook notifications by workflow step kinds. * Only workflow steps matching these kinds will trigger webhook notifications. * If empty, all workflow step kinds will trigger notifications. * @type {Array} * @memberof Webhook */ triggers?: Array; /** * * @type {Date} * @memberof Webhook */ readonly updatedAt?: Date; /** * * @type {string} * @memberof Webhook */ workspaceId?: string; } /** * @export */ export declare const WebhookTriggersEnum: { readonly KindUnspecified: "KIND_UNSPECIFIED"; readonly KindEntry: "KIND_ENTRY"; readonly KindExit: "KIND_EXIT"; readonly KindInteraction: "KIND_INTERACTION"; readonly KindCondition: "KIND_CONDITION"; }; export type WebhookTriggersEnum = typeof WebhookTriggersEnum[keyof typeof WebhookTriggersEnum]; /** * Check if a given object implements the Webhook interface. */ export declare function instanceOfWebhook(value: object): value is Webhook; export declare function WebhookFromJSON(json: any): Webhook; export declare function WebhookFromJSONTyped(json: any, ignoreDiscriminator: boolean): Webhook; export declare function WebhookToJSON(json: any): Webhook; export declare function WebhookToJSONTyped(value?: Omit | null, ignoreDiscriminator?: boolean): any;