@kaibanjs/tools/dist/zapier-webhook/index.d.ts

A set of tools to work with LLMs and KaibanJS

/**
 * Zapier Webhook Tool
 *
 * This tool allows integration with Zapier's webhook service, enabling seamless
 * interaction with thousands of apps and services supported by Zapier. It is
 * designed to trigger workflows and automate tasks across various applications
 * using Zapier's webhook functionality.
 *
 * Key features of Zapier Webhook Tool:
 * - Easy integration with Zapier's webhook service
 * - Trigger workflows and automate tasks across thousands of apps
 * - Configurable options for webhook events and payloads
 *
 * For more information about Zapier, visit: https://zapier.com/
 */
import { StructuredTool } from '@langchain/core/tools';
import { z } from 'zod';
/**
 * Type for the parameters in ZapierWebhook
 * @typedef {string} ZapierWebhookParams
 * @example
 * {
 *   schema: z.object({
 *     name: z.string(),
 *     email: z.string().email(),
 */
type ZapierWebhookParams = {
    schema: z.ZodObject<any>;
};
/**
 * Response type for the ZapierWebhook tool
 * @typedef {string} ZapierWebhookResult
 * @example
 * "Webhook response success"
 */
type ZapierWebhookResult = string;
/**
 * Error type for the ZapierWebhook tool
 * @typedef {string} ZapierWebhookError
 * @example
 * "API request failed: Client Error (404)"
 */
type ZapierWebhookError = string;
/**
 * Type for the response from the ZapierWebhook tool
 * @typedef {ZapierWebhookResult | ZapierWebhookError} ZapierWebhookResponse
 * @example
 * "Webhook response success"
 */
type ZapierWebhookResponse = ZapierWebhookResult | ZapierWebhookError;
/**
 * Interface for the ZapierWebhook tool
 * @typedef {Object} ZapierWebhookFields
 * @property {string} url - The Zapier webhook URL.
 * @property {z.ZodObject<any>} schema - The schema for the input data using Zod.
 */
interface ZapierWebhookFields {
    url: string;
    schema: z.ZodObject<any>;
}
/**
 * ZapierWebhook tool class
 * @extends StructuredTool
 */
export declare class ZapierWebhook extends StructuredTool {
    private url;
    private httpClient;
    name: string;
    description: string;
    schema: z.ZodObject<any>;
    /**
     * Create a ZapierWebhook tool.
     * @param fields - The configuration fields for the tool.
     * @param fields.url - The Zapier webhook URL.
     * @param fields.schema - The schema for the input data using Zod.
     */
    constructor(fields: ZapierWebhookFields);
    /**
     * Call the Zapier webhook with the provided input data.
     * @param input - The input data for the webhook.
     * @returns The response from the webhook as a JSON string.
     */
    _call(input: ZapierWebhookParams): Promise<ZapierWebhookResponse>;
}
export {};