fathom-typescript
Version:
Fathom's official TypeScript SDK.
56 lines • 2.61 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../../types/enums.js";
export declare const TriggeredFor: {
readonly MyRecordings: "my_recordings";
readonly SharedExternalRecordings: "shared_external_recordings";
readonly MySharedWithTeamRecordings: "my_shared_with_team_recordings";
readonly SharedTeamRecordings: "shared_team_recordings";
};
export type TriggeredFor = ClosedEnum<typeof TriggeredFor>;
export type CreateWebhookRequest = {
/**
* The URL to send the webhook to.
*/
destinationUrl: string;
/**
* Include the action items for each meeting.
*/
includeActionItems?: boolean | undefined;
/**
* Include CRM matches for each meeting. Only returns data from your or your team's linked CRM.
*/
includeCrmMatches?: boolean | undefined;
/**
* Include the summary for each meeting.
*/
includeSummary?: boolean | undefined;
/**
* Include the transcript for each meeting.
*/
includeTranscript?: boolean | undefined;
/**
* You must send at least one of the following types of recordings to trigger on.
*
* @remarks
* - `my_recordings`: Your private recordings, as well as those you've shared with individuals. (On Team Plans, this excludes recordings you've shared with any teams.)
* - `shared_external_recordings`: Recordings shared with you by other users. (For Team Plans, this does not include recordings shared by other users on your Team Plan.)
* - `my_shared_with_team_recordings`: (Team Plans only). All recordings that you have shared with other teams (e.g. Marketing or Sales). Recordings you've shared with individuals but not with teams are not included.
* - `shared_team_recordings`: (Team Plans only) All recordings you can access from other users on your Team Plan, whether shared with you individually or with your team.
*/
triggeredFor: Array<TriggeredFor>;
};
/** @internal */
export declare const TriggeredFor$outboundSchema: z.ZodNativeEnum<typeof TriggeredFor>;
/** @internal */
export type CreateWebhookRequest$Outbound = {
destination_url: string;
include_action_items: boolean;
include_crm_matches: boolean;
include_summary: boolean;
include_transcript: boolean;
triggered_for: Array<string>;
};
/** @internal */
export declare const CreateWebhookRequest$outboundSchema: z.ZodType<CreateWebhookRequest$Outbound, z.ZodTypeDef, CreateWebhookRequest>;
export declare function createWebhookRequestToJSON(createWebhookRequest: CreateWebhookRequest): string;
//# sourceMappingURL=createwebhook.d.ts.map