dist¶

Interfaces¶

FreshdeskJsonObject¶

Indexable¶

[key: string]: FreshdeskJsonValue

FreshdeskTicketingClient¶

Extends¶

FreshdeskTicketingProviderClient

Properties¶

providerClient¶

providerClient: FreshdeskTicketingProviderClient;

Methods¶

createNote()¶

createNote(ticketId, body): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`ticketId`	`string` \| `number`
`body`	`FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.createNote

createReply()¶

createReply(ticketId, body): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`ticketId`	`string` \| `number`
`body`	`FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.createReply

createTicket()¶

createTicket(input): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`input`	`FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.createTicket

getAgent()¶

getAgent(agentId): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`agentId`	`string` \| `number`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.getAgent

getContact()¶

getContact(contactId): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`contactId`	`string` \| `number`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.getContact

getGroup()¶

getGroup(groupId): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`groupId`	`string` \| `number`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.getGroup

getTicket()¶

getTicket(ticketId): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`ticketId`	`string` \| `number`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.getTicket

readiness()¶

readiness(): Promise<FreshdeskJsonObject>;

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.readiness

searchContacts()¶

searchContacts(query): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`query`	`string` \| `FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.searchContacts

searchTickets()¶

searchTickets(query): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`query`	`string` \| `FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.searchTickets

updateTicket()¶

updateTicket(ticketId, patch): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`ticketId`	`string` \| `number`
`patch`	`FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

Inherited from¶

FreshdeskTicketingProviderClient.updateTicket

FreshdeskTicketingClientOptions¶

Properties¶

apiKey?¶

optional apiKey?: string;

domain?¶

optional domain?: string;

providerClient?¶

optional providerClient?: FreshdeskTicketingProviderClient;

FreshdeskTicketingProviderClient¶

Extended by¶

FreshdeskTicketingClient

Methods¶

createNote()¶

createNote(ticketId, body): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`ticketId`	`string` \| `number`
`body`	`FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

createReply()¶

createReply(ticketId, body): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`ticketId`	`string` \| `number`
`body`	`FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

createTicket()¶

createTicket(input): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`input`	`FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

getAgent()¶

getAgent(agentId): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`agentId`	`string` \| `number`

Returns¶

Promise\<FreshdeskJsonObject>

getContact()¶

getContact(contactId): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`contactId`	`string` \| `number`

Returns¶

Promise\<FreshdeskJsonObject>

getGroup()¶

getGroup(groupId): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`groupId`	`string` \| `number`

Returns¶

Promise\<FreshdeskJsonObject>

getTicket()¶

getTicket(ticketId): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`ticketId`	`string` \| `number`

Returns¶

Promise\<FreshdeskJsonObject>

readiness()¶

readiness(): Promise<FreshdeskJsonObject>;

Returns¶

Promise\<FreshdeskJsonObject>

searchContacts()¶

searchContacts(query): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`query`	`string` \| `FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

searchTickets()¶

searchTickets(query): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`query`	`string` \| `FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

updateTicket()¶

updateTicket(ticketId, patch): Promise<FreshdeskJsonObject>;

Parameters¶

Parameter	Type
`ticketId`	`string` \| `number`
`patch`	`FreshdeskJsonObject`

Returns¶

Promise\<FreshdeskJsonObject>

FreshdeskWebhookOptions¶

Properties¶

headerName?¶

optional headerName?: string;

webhookSecret?¶

optional webhookSecret?: string;

Type Aliases¶

FreshdeskJsonPrimitive¶

type FreshdeskJsonPrimitive = string | number | boolean | null;

FreshdeskJsonValue¶

type FreshdeskJsonValue =
  | FreshdeskJsonPrimitive
  | FreshdeskJsonObject
  | FreshdeskJsonValue[];

FreshdeskProviderPayload¶

type FreshdeskProviderPayload = FreshdeskJsonObject;

JsonObject¶

type JsonObject = FreshdeskJsonObject;

JsonPrimitive¶

type JsonPrimitive = FreshdeskJsonPrimitive;

JsonValue¶

type JsonValue = FreshdeskJsonValue;

Variables¶

createFreshdeskIntegration¶

const createFreshdeskIntegration: typeof createFreshdeskTicketingIntegration;

createFreshdeskIntegrationOperationHandlers¶

const createFreshdeskIntegrationOperationHandlers: typeof createFreshdeskTicketingIntegrationOperationHandlers;

Functions¶

createFreshdeskTicketingClient()¶

function createFreshdeskTicketingClient(options?): FreshdeskTicketingClient;

Parameters¶

Parameter	Type
`options?`	`FreshdeskTicketingClientOptions`

Returns¶

FreshdeskTicketingClient

createFreshdeskTicketingIntegration()¶

function createFreshdeskTicketingIntegration(options): DefinedIntegration<{
  capabilities: [{
     capability: "receive";
     exposesSensitiveData: true;
     providerObjects: [{
        kind: "freshdeskWebhookEvent";
        label: "Freshdesk Webhook Event";
     }];
     requiresCredential: true;
   }, {
     capability: "create-provider-object";
     changesWorkflow: true;
     exposesSensitiveData: true;
     providerObjects: [{
        kind: "freshdeskTicket";
        label: "Freshdesk Ticket";
      }, {
        kind: "freshdeskContact";
        label: "Freshdesk Contact";
      }, {
        kind: "freshdeskConversation";
        label: "Freshdesk Ticket Conversation";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     capability: "read-provider-object";
     exposesSensitiveData: true;
     providerObjects: [{
        kind: "freshdeskTicket";
        label: "Freshdesk Ticket";
      }, {
        kind: "freshdeskContact";
        label: "Freshdesk Contact";
      }, {
        kind: "freshdeskAgent";
        label: "Freshdesk Agent";
      }, {
        kind: "freshdeskGroup";
        label: "Freshdesk Group";
     }];
     requiresCredential: true;
  }];
  category: "ticketing";
  channelAudiences: ["customer-facing", "internal-support", "mixed"];
  coverage: {
     evidence: [{
        label: "Freshdesk API v2 reference";
        url: "https://developers.freshdesk.com/api/";
      }, {
        label: "Freshworks Freshdesk SDK";
        url: "https://www.npmjs.com/package/@freshworks/freshdesk";
      }, {
        label: "Freshworks API SDK";
        url: "https://www.npmjs.com/package/@freshworks/api-sdk";
      }, {
        label: "Freshworks API SDK repository";
        url: "https://github.com/freshworks/freshworks-api-sdk";
      }, {
        label: "Freshworks API SDK announcement";
        url: "https://community.freshworks.dev/t/freshworks-api-sdk-for-node-js/5232";
     }];
     notes: ["Implementation uses the official @freshworks/freshdesk JavaScript SDK by default when domain and apiKey are configured.", "Operations not exposed by the official SDK, such as agents, groups, and current-agent readiness, require an injected FreshdeskTicketingProviderClient instead of a package-owned REST fallback.", "Coverage is limited to Freshdesk v2 tickets, contacts, conversations, replies, notes, handoff updates, agents, groups, current-agent readiness, and SDK-user shared-secret webhook validation."];
     scope: "provider-api-subset";
  };
  credentialRequirements: [{
     id: "freshdesk-domain";
     label: "Freshdesk domain";
     required: true;
   }, {
     id: "freshdesk-api-key";
     label: "Freshdesk API key";
     metadata: {
        privilegeGuidance: "Freshdesk API keys are governed by the authenticated agent's Freshdesk role and ticket permissions.";
        scopeKind: "internal-capability-labels";
     };
     required: true;
     scopes: ["read", "write"];
   }, {
     id: "freshdesk-webhook-secret";
     label: "Freshdesk webhook shared secret";
     required: false;
  }];
  directions: ["receive-only", "send-only", "bidirectional"];
  id: "ticketing.freshdesk";
  limitations: ["Ticket forms, required fields, statuses, products, groups, SLAs, automations, and agent permissions are SDK-user configuration."];
  maintainers: [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     freshdeskV2Coverage: {
        allowlistedOperations: readonly ["tickets.create", "tickets.read", "tickets.update", "tickets.search", "reply.create", "note.create", "contacts.read", "contacts.search", "agents.read", "groups.read", "agents.me", "automation_webhook.parse"];
        source: "Freshdesk API v2";
     };
     implementation: {
        defaultClientPolicy: "use-official-freshworks-freshdesk-sdk-when-domain-and-apiKey-are-configured";
        delegatedOperationTarget: "official Freshdesk SDK for covered operations or injected Freshdesk provider client for SDK gaps";
        packageOwnedRestClient: false;
        packageOwnedRestFallback: false;
        providerClient: "FreshdeskTicketingProviderClient";
        providerClientInterface: "FreshdeskTicketingProviderClient";
        providerClientOverride: true;
        providerSdkPackage: "@freshworks/freshdesk";
        rawClientEscapeHatch: "FreshdeskTicketingClient.providerClient";
        rawClientOverride: true;
        runtimePackage: "@cognidesk/integration-ticketing-freshdesk";
        sdkDecision: {
           checkedAt: "2026-06-25";
           checkedVersion: "0.0.1";
           license: "freshdesk";
           notes: readonly ["@freshworks/freshdesk 0.0.1 exposes tickets.createTicket/getTicket/updateTicket/searchTicket/replyTicket/addNotes and contacts.getContact/searchContacts.", "The package does not expose agents/groups/readiness helpers; those operations fail closed unless a host FreshdeskTicketingProviderClient is injected."];
           package: "@freshworks/freshdesk";
           packageChecked: "@freshworks/freshdesk";
           reason: "@freshworks/freshdesk exposes Freshdesk tickets, contacts, and conversations runtime clients. Agents, groups, and current-agent readiness are not exposed by that package and require FreshdeskTicketingProviderClient injection.";
           result: "accepted-runtime-sdk";
        };
        strategy: "provider-sdk-adapter";
     };
     issue: 35;
     sdkDecision: {
        checkedAt: "2026-06-25";
        checkedVersion: "0.0.1";
        license: "freshdesk";
        package: "@freshworks/freshdesk";
        reason: "@freshworks/freshdesk is the official Freshdesk JavaScript SDK and is used for the ticket/contact operations it exposes.";
        result: "accepted-runtime-sdk";
     };
  };
  name: "Freshdesk Ticketing";
  operations: [{
     alias: "ticket.create";
     capability: "create-provider-object";
     changesWorkflow: true;
     exposesSensitiveData: true;
     providerObject: "ticket";
     providerOperation: "POST /api/v2/tickets";
     sideEffect: true;
   }, {
     alias: "ticket.read";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     providerObject: "ticket";
     providerOperation: "GET /api/v2/tickets/{ticket_id}";
   }, {
     alias: "ticket.update";
     capability: "update-provider-object";
     changesWorkflow: true;
     exposesSensitiveData: true;
     providerObject: "ticket";
     providerOperation: "PUT /api/v2/tickets/{ticket_id}";
     sideEffect: true;
  }];
  packageName: "@cognidesk/integration-ticketing-freshdesk";
  privacyNotes: ["Freshdesk tickets, conversations, notes, contacts, assignments, tags, custom fields, and automation webhook payloads can contain customer data."];
  provider: "freshdesk";
  trustLevel: "official";
}, unknown, {
  customer.read: (input, _context) => Promise<FreshdeskJsonObject>;
  customer.search: (input, _context) => Promise<FreshdeskJsonObject>;
  freshdesk.agent.read: (input, _context) => Promise<FreshdeskJsonObject>;
  freshdesk.group.read: (input, _context) => Promise<FreshdeskJsonObject>;
  freshdesk.readiness: () => Promise<FreshdeskJsonObject>;
  freshdesk.webhook.parse: (input) => Promise<{
     event: {
        payload: FreshdeskJsonObject;
        provider: string;
     };
     verified: boolean;
  }>;
  ticket.comment.create: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.create: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.internalNote.create: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.read: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.search: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.update: (input, _context) => Promise<FreshdeskJsonObject>;
}>;

Parameters¶

Parameter	Type
`options`	`FreshdeskTicketingIntegrationOptions`

Returns¶

DefinedIntegration\<{ capabilities: [{ capability: "receive"; exposesSensitiveData: true; providerObjects: [{ kind: "freshdeskWebhookEvent"; label: "Freshdesk Webhook Event"; }]; requiresCredential: true; }, { capability: "create-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObjects: [{ kind: "freshdeskTicket"; label: "Freshdesk Ticket"; }, { kind: "freshdeskContact"; label: "Freshdesk Contact"; }, { kind: "freshdeskConversation"; label: "Freshdesk Ticket Conversation"; }]; requiresCredential: true; sideEffect: true; }, { capability: "read-provider-object"; exposesSensitiveData: true; providerObjects: [{ kind: "freshdeskTicket"; label: "Freshdesk Ticket"; }, { kind: "freshdeskContact"; label: "Freshdesk Contact"; }, { kind: "freshdeskAgent"; label: "Freshdesk Agent"; }, { kind: "freshdeskGroup"; label: "Freshdesk Group"; }]; requiresCredential: true; }]; category: "ticketing"; channelAudiences: ["customer-facing", "internal-support", "mixed"]; coverage: { evidence: [{ label: "Freshdesk API v2 reference"; url: "https://developers.freshdesk.com/api/"; }, { label: "Freshworks Freshdesk SDK"; url: "https://www.npmjs.com/package/@freshworks/freshdesk"; }, { label: "Freshworks API SDK"; url: "https://www.npmjs.com/package/@freshworks/api-sdk"; }, { label: "Freshworks API SDK repository"; url: "https://github.com/freshworks/freshworks-api-sdk"; }, { label: "Freshworks API SDK announcement"; url: "https://community.freshworks.dev/t/freshworks-api-sdk-for-node-js/5232"; }]; notes: ["Implementation uses the official @freshworks/freshdesk JavaScript SDK by default when domain and apiKey are configured.", "Operations not exposed by the official SDK, such as agents, groups, and current-agent readiness, require an injected FreshdeskTicketingProviderClient instead of a package-owned REST fallback.", "Coverage is limited to Freshdesk v2 tickets, contacts, conversations, replies, notes, handoff updates, agents, groups, current-agent readiness, and SDK-user shared-secret webhook validation."]; scope: "provider-api-subset"; }; credentialRequirements: [{ id: "freshdesk-domain"; label: "Freshdesk domain"; required: true; }, { id: "freshdesk-api-key"; label: "Freshdesk API key"; metadata: { privilegeGuidance: "Freshdesk API keys are governed by the authenticated agent's Freshdesk role and ticket permissions."; scopeKind: "internal-capability-labels"; }; required: true; scopes: ["read", "write"]; }, { id: "freshdesk-webhook-secret"; label: "Freshdesk webhook shared secret"; required: false; }]; directions: ["receive-only", "send-only", "bidirectional"]; id: "ticketing.freshdesk"; limitations: ["Ticket forms, required fields, statuses, products, groups, SLAs, automations, and agent permissions are SDK-user configuration."]; maintainers: [{ name: "Cognidesk"; type: "official"; }]; metadata: { freshdeskV2Coverage: { allowlistedOperations: readonly ["tickets.create", "tickets.read", "tickets.update", "tickets.search", "reply.create", "note.create", "contacts.read", "contacts.search", "agents.read", "groups.read", "agents.me", "automation_webhook.parse"]; source: "Freshdesk API v2"; }; implementation: { defaultClientPolicy: "use-official-freshworks-freshdesk-sdk-when-domain-and-apiKey-are-configured"; delegatedOperationTarget: "official Freshdesk SDK for covered operations or injected Freshdesk provider client for SDK gaps"; packageOwnedRestClient: false; packageOwnedRestFallback: false; providerClient: "FreshdeskTicketingProviderClient"; providerClientInterface: "FreshdeskTicketingProviderClient"; providerClientOverride: true; providerSdkPackage: "@freshworks/freshdesk"; rawClientEscapeHatch: "FreshdeskTicketingClient.providerClient"; rawClientOverride: true; runtimePackage: "@cognidesk/integration-ticketing-freshdesk"; sdkDecision: { checkedAt: "2026-06-25"; checkedVersion: "0.0.1"; license: "freshdesk"; notes: readonly ["@freshworks/freshdesk 0.0.1 exposes tickets.createTicket/getTicket/updateTicket/searchTicket/replyTicket/addNotes and contacts.getContact/searchContacts.", "The package does not expose agents/groups/readiness helpers; those operations fail closed unless a host FreshdeskTicketingProviderClient is injected."]; package: "@freshworks/freshdesk"; packageChecked: "@freshworks/freshdesk"; reason: "@freshworks/freshdesk exposes Freshdesk tickets, contacts, and conversations runtime clients. Agents, groups, and current-agent readiness are not exposed by that package and require FreshdeskTicketingProviderClient injection."; result: "accepted-runtime-sdk"; }; strategy: "provider-sdk-adapter"; }; issue: 35; sdkDecision: { checkedAt: "2026-06-25"; checkedVersion: "0.0.1"; license: "freshdesk"; package: "@freshworks/freshdesk"; reason: "@freshworks/freshdesk is the official Freshdesk JavaScript SDK and is used for the ticket/contact operations it exposes."; result: "accepted-runtime-sdk"; }; }; name: "Freshdesk Ticketing"; operations: [{ alias: "ticket.create"; capability: "create-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "ticket"; providerOperation: "POST /api/v2/tickets"; sideEffect: true; }, { alias: "ticket.read"; capability: "read-provider-object"; exposesSensitiveData: true; providerObject: "ticket"; providerOperation: "GET /api/v2/tickets/{ticket_id}"; }, { alias: "ticket.update"; capability: "update-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "ticket"; providerOperation: "PUT /api/v2/tickets/{ticket_id}"; sideEffect: true; }]; packageName: "@cognidesk/integration-ticketing-freshdesk"; privacyNotes: ["Freshdesk tickets, conversations, notes, contacts, assignments, tags, custom fields, and automation webhook payloads can contain customer data."]; provider: "freshdesk"; trustLevel: "official"; }, unknown, { customer.read: (input, _context) => Promise\<FreshdeskJsonObject>; customer.search: (input, _context) => Promise\<FreshdeskJsonObject>; freshdesk.agent.read: (input, _context) => Promise\<FreshdeskJsonObject>; freshdesk.group.read: (input, _context) => Promise\<FreshdeskJsonObject>; freshdesk.readiness: () => Promise\<FreshdeskJsonObject>; freshdesk.webhook.parse: (input) => Promise\<{ event: { payload: FreshdeskJsonObject; provider: string; }; verified: boolean; }>; ticket.comment.create: (input, _context) => Promise\<FreshdeskJsonObject>; ticket.create: (input, _context) => Promise\<FreshdeskJsonObject>; ticket.internalNote.create: (input, _context) => Promise\<FreshdeskJsonObject>; ticket.read: (input, _context) => Promise\<FreshdeskJsonObject>; ticket.search: (input, _context) => Promise\<FreshdeskJsonObject>; ticket.update: (input, _context) => Promise\<FreshdeskJsonObject>; }>

createFreshdeskTicketingIntegrationOperationHandlers()¶

function createFreshdeskTicketingIntegrationOperationHandlers(options): {
  customer.read: (input, _context) => Promise<FreshdeskJsonObject>;
  customer.search: (input, _context) => Promise<FreshdeskJsonObject>;
  freshdesk.agent.read: (input, _context) => Promise<FreshdeskJsonObject>;
  freshdesk.group.read: (input, _context) => Promise<FreshdeskJsonObject>;
  freshdesk.readiness: () => Promise<FreshdeskJsonObject>;
  freshdesk.webhook.parse: (input) => Promise<{
     event: {
        payload: FreshdeskJsonObject;
        provider: string;
     };
     verified: boolean;
  }>;
  ticket.comment.create: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.create: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.internalNote.create: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.read: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.search: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.update: (input, _context) => Promise<FreshdeskJsonObject>;
};

Parameters¶

Parameter	Type
`options`	`FreshdeskTicketingIntegrationOptions`

Returns¶

{
  customer.read: (input, _context) => Promise<FreshdeskJsonObject>;
  customer.search: (input, _context) => Promise<FreshdeskJsonObject>;
  freshdesk.agent.read: (input, _context) => Promise<FreshdeskJsonObject>;
  freshdesk.group.read: (input, _context) => Promise<FreshdeskJsonObject>;
  freshdesk.readiness: () => Promise<FreshdeskJsonObject>;
  freshdesk.webhook.parse: (input) => Promise<{
     event: {
        payload: FreshdeskJsonObject;
        provider: string;
     };
     verified: boolean;
  }>;
  ticket.comment.create: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.create: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.internalNote.create: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.read: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.search: (input, _context) => Promise<FreshdeskJsonObject>;
  ticket.update: (input, _context) => Promise<FreshdeskJsonObject>;
}

Name	Type
`customer.read()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>
`customer.search()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>
`freshdesk.agent.read()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>
`freshdesk.group.read()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>
`freshdesk.readiness()`	() => `Promise`\<`FreshdeskJsonObject`>
`freshdesk.webhook.parse()`	(`input`) => `Promise`\<{ `event`: { `payload`: `FreshdeskJsonObject`; `provider`: `string`; }; `verified`: `boolean`; }>
`ticket.comment.create()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>
`ticket.create()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>
`ticket.internalNote.create()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>
`ticket.read()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>
`ticket.search()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>
`ticket.update()`	(`input`, `_context`) => `Promise`\<`FreshdeskJsonObject`>

createFreshdeskUnavailableClient()¶

function createFreshdeskUnavailableClient(message?): FreshdeskTicketingProviderClient;

Parameters¶

Parameter	Type
`message?`	`string`

Returns¶

FreshdeskTicketingProviderClient

createFreshworksFreshdeskProviderClient()¶

function createFreshworksFreshdeskProviderClient(options): FreshdeskTicketingProviderClient;

Parameters¶

Parameter	Type
`options`	`FreshdeskTicketingClientOptions`

Returns¶

FreshdeskTicketingProviderClient

createFreshworksFreshdeskSdkProviderClient()¶

function createFreshworksFreshdeskSdkProviderClient(sdkClient): FreshdeskTicketingProviderClient;

Parameters¶

Parameter	Type
`sdkClient`	`FreshdeskSdkClient`

Returns¶

FreshdeskTicketingProviderClient

parseFreshdeskWebhookRequest()¶

function parseFreshdeskWebhookRequest(request, options?): Promise<{
  event: {
     payload: FreshdeskJsonObject;
     provider: string;
  };
  verified: boolean;
}>;

Parameters¶

Parameter	Type
`request`	`Request`
`options?`	`FreshdeskWebhookOptions`

Returns¶

Promise\<{ event: { payload: FreshdeskJsonObject; provider: string; }; verified: boolean; }>

validateFreshdeskWebhookSecret()¶

function validateFreshdeskWebhookSecret(headers, options?): boolean;

Parameters¶

Parameter	Type
`headers`	`Headers`
`options?`	`FreshdeskWebhookOptions`

Returns¶

boolean

References¶

freshdeskTicketingProviderManifest¶

Re-exports freshdeskTicketingProviderManifest