integrations/ticketing/zendesk/dist/manifest¶
Variables¶
zendeskTicketingOperationAliases¶
const zendeskTicketingOperationAliases: readonly ["ticket.create", "ticket.read", "ticket.update", "ticket.search", "ticket.comment.create", "ticket.internalNote.create", "ticket.attachments.add", "customer.read", "zendesk.organization.read", "zendesk.webhook.list", "zendesk.readiness"];
zendeskTicketingProviderManifest¶
const zendeskTicketingProviderManifest: {
capabilities: {
audiences?: ("customer-facing" | "internal-support" | "mixed")[];
capability: string;
changesWorkflow?: boolean;
description?: string;
exposesSensitiveData?: boolean;
extension?: boolean;
label?: string;
metadata?: Record<string, unknown>;
providerObjects?: {
description?: string;
kind: string;
label?: string;
metadata?: Record<string, unknown>;
schemaName?: string;
}[];
requiresCredential?: boolean;
sideEffect?: boolean;
}[];
category: string;
channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
coverage: {
evidence: {
label: string;
url?: string;
}[];
notes: string[];
scope: | "support-workflow-subset"
| "provider-api-subset"
| "connector-required"
| "local-protocol"
| "full-provider-api";
};
credentialRequirements: {
description?: string;
id: string;
label?: string;
metadata?: Record<string, unknown>;
required: boolean;
scopes: string[];
}[];
directions: (
| "receive-only"
| "send-only"
| "inbound-only"
| "outbound-only"
| "bidirectional")[];
id: string;
limitations: string[];
maintainers: {
name: string;
type: "community" | "official" | "unknown" | "partner";
url?: string;
}[];
metadata?: Record<string, unknown>;
name: string;
operations: {
alias: string;
audience?: "customer-facing" | "internal-support" | "mixed";
audiences?: ("customer-facing" | "internal-support" | "mixed")[];
capability: string;
changesWorkflow?: boolean;
description?: string;
exposesSensitiveData?: boolean;
extension: boolean;
externallyVisible?: boolean;
inputSchema?: unknown;
inputSchemaName?: string;
inputSchemaRef?: string;
label?: string;
metadata?: Record<string, unknown>;
outputSchema?: unknown;
outputSchemaName?: string;
outputSchemaRef?: string;
providerObject?: string;
providerObjects?: {
description?: string;
kind: string;
label?: string;
metadata?: Record<string, unknown>;
schemaName?: string;
}[];
providerOperation?: string;
requiredPolicyIds?: string[];
requiresApproval?: boolean;
requiresCredential?: boolean;
sideEffect?: boolean;
}[];
packageName: string;
privacyNotes: string[];
provider: string;
trustLevel: "community" | "official" | "verified" | "experimental";
} & {
capabilities: [{
capability: "create-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}, {
kind: "zendeskTicketComment";
label: "Zendesk Ticket Comment";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "read-provider-object";
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}, {
kind: "zendeskUser";
label: "Zendesk User";
}, {
kind: "zendeskOrganization";
label: "Zendesk Organization";
}, {
kind: "zendeskWebhook";
label: "Zendesk Webhook";
}];
requiresCredential: true;
}, {
capability: "update-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "search-provider-object";
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}];
requiresCredential: true;
}, {
capability: "send";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicketComment";
label: "Zendesk Ticket Comment";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "draft";
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskInternalNote";
label: "Zendesk Internal Note";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "attach";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicketAttachment";
label: "Zendesk Ticket Attachment";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "handoff";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}, {
kind: "zendeskTicketComment";
label: "Zendesk Ticket Comment";
}];
requiresCredential: true;
sideEffect: true;
}];
category: "ticketing";
channelAudiences: ["customer-facing", "internal-support", "mixed"];
coverage: {
evidence: [{
label: "node-zendesk package";
url: "https://www.npmjs.com/package/node-zendesk";
}, {
label: "Zendesk Node.js API client docs";
url: "https://developer.zendesk.com/documentation/ticketing/api-clients/nodejs/";
}, {
label: "Zendesk Support API OpenAPI";
url: "https://developer.zendesk.com/zendesk/oas.yaml";
}, {
label: "Zendesk Support Tickets API";
url: "https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/";
}, {
label: "Zendesk Ticket Comments API";
url: "https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/";
}, {
label: "Zendesk Upload Files API";
url: "https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/";
}];
notes: ["Coverage is a Cognidesk support workflow adapter backed by the node-zendesk provider SDK.", "Typed operations cover ticket create/read/update/search, public comments, internal notes, upload-and-attach, users, organizations, webhooks list, current-user readiness, and a node-zendesk rawClient escape hatch for SDK-user-owned advanced methods.", "This package intentionally does not copy the old generated full Zendesk Support OpenAPI clone."];
scope: "support-workflow-subset";
};
credentialRequirements: [{
id: "zendesk-instance";
label: "Zendesk Support instance URL";
required: true;
}, {
id: "zendesk-api-access";
label: "Zendesk Support API access";
metadata: {
privilegeGuidance: "OAuth tokens use Zendesk read/write scopes. API-token credentials inherit the Zendesk user's role and Support permissions.";
scopeKind: "mixed-auth-mode";
};
required: true;
scopes: ["read", "write"];
}];
directions: ["bidirectional"];
id: "ticketing.zendesk";
limitations: ["Tenant fields, triggers, automations, macros, routing, requester identity, and outbound policy remain SDK-user configuration."];
maintainers: [{
name: "Cognidesk";
type: "official";
}];
metadata: {
channelCoverage: {
broaderZendeskApi: "provider-sdk-raw-client";
comments: "sdk-backed-ticket-update-comment";
organizations: "sdk-backed-read";
tickets: "sdk-backed-create-read-update-search";
uploads: "sdk-backed-attachments-upload-and-ticket-comment-association";
users: "sdk-backed-read-current-user";
webhooks: "sdk-backed-list";
};
implementation: {
manifestImport: "no-sdk-client-initialization";
rawClientEscapeHatch: "ZendeskTicketingClient.rawClient / getRawClient()";
sdkPackage: "node-zendesk";
sdkVersionRange: "^6.0.1";
strategy: "provider-sdk-backed-client";
};
implementationStrategy: "node-zendesk-sdk-backed-support-workflow-subset";
integrationEntryPoints: {
manifest: "@cognidesk/integration-ticketing-zendesk/manifest";
runtime: "@cognidesk/integration-ticketing-zendesk/runtime";
};
integrationName: "Zendesk Integration";
integrationPackageName: "@cognidesk/integration-ticketing-zendesk";
issue: 35;
providerClient: {
importPolicy: "runtime-entrypoint-only";
package: "node-zendesk";
versionRange: "^6.0.1";
};
};
name: "Zendesk Support";
operations: [{
alias: "ticket.create";
capability: "create-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "ticket";
providerOperation: "POST /api/v2/tickets.json";
sideEffect: true;
}, {
alias: "ticket.read";
capability: "read-provider-object";
exposesSensitiveData: true;
providerObject: "ticket";
providerOperation: "GET /api/v2/tickets/{ticket_id}.json";
}, {
alias: "ticket.update";
capability: "update-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "ticket";
providerOperation: "PUT /api/v2/tickets/{ticket_id}.json";
sideEffect: true;
}, {
alias: "ticket.search";
capability: "search-provider-object";
exposesSensitiveData: true;
providerObject: "ticket";
providerOperation: "GET /api/v2/search.json";
}, {
alias: "ticket.comment.create";
capability: "send";
exposesSensitiveData: true;
externallyVisible: true;
providerObject: "ticketComment";
providerOperation: "PUT /api/v2/tickets/{ticket_id}.json";
sideEffect: true;
}, {
alias: "ticket.internalNote.create";
capability: "draft";
exposesSensitiveData: true;
providerObject: "internalNote";
providerOperation: "PUT /api/v2/tickets/{ticket_id}.json";
sideEffect: true;
}, {
alias: "ticket.attachments.add";
capability: "attach";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "attachment";
providerOperation: "POST /api/v2/uploads.json + PUT /api/v2/tickets/{ticket_id}.json";
sideEffect: true;
}, {
alias: "customer.read";
capability: "read-provider-object";
exposesSensitiveData: true;
providerObject: "customer";
providerOperation: "GET /api/v2/users/{user_id}.json";
}, {
alias: "zendesk.organization.read";
capability: "read-provider-object";
exposesSensitiveData: true;
extension: true;
providerObject: "zendeskOrganization";
providerOperation: "GET /api/v2/organizations/{organization_id}.json";
}, {
alias: "zendesk.webhook.list";
capability: "search-provider-object";
exposesSensitiveData: true;
extension: true;
providerObject: "zendeskWebhook";
providerOperation: "GET /api/v2/webhooks";
}, {
alias: "zendesk.readiness";
capability: "read-provider-object";
exposesSensitiveData: true;
extension: true;
providerObject: "zendeskCurrentUser";
providerOperation: "GET /api/v2/users/me.json";
}];
packageName: "@cognidesk/integration-ticketing-zendesk";
privacyNotes: ["Zendesk tickets can contain customer messages, requester details, internal comments, tags, and workflow metadata."];
provider: "zendesk";
trustLevel: "official";
};
Type Declaration¶
| Name | Type |
|---|---|
capabilities |
{ audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension?: boolean; label?: string; metadata?: Record\<string, unknown>; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; requiresCredential?: boolean; sideEffect?: boolean; }[] |
category |
string |
channelAudiences |
("customer-facing" | "internal-support" | "mixed")[] |
coverage |
{ evidence: { label: string; url?: string; }[]; notes: string[]; scope: | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"; } |
coverage.evidence |
{ label: string; url?: string; }[] |
coverage.notes |
string[] |
coverage.scope |
| "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api" |
credentialRequirements |
{ description?: string; id: string; label?: string; metadata?: Record\<string, unknown>; required: boolean; scopes: string[]; }[] |
directions |
( | "receive-only" | "send-only" | "inbound-only" | "outbound-only" | "bidirectional")[] |
id |
string |
limitations |
string[] |
maintainers |
{ name: string; type: "community" | "official" | "unknown" | "partner"; url?: string; }[] |
metadata? |
Record\<string, unknown> |
name |
string |
operations |
{ alias: string; audience?: "customer-facing" | "internal-support" | "mixed"; audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension: boolean; externallyVisible?: boolean; inputSchema?: unknown; inputSchemaName?: string; inputSchemaRef?: string; label?: string; metadata?: Record\<string, unknown>; outputSchema?: unknown; outputSchemaName?: string; outputSchemaRef?: string; providerObject?: string; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; providerOperation?: string; requiredPolicyIds?: string[]; requiresApproval?: boolean; requiresCredential?: boolean; sideEffect?: boolean; }[] |
packageName |
string |
privacyNotes |
string[] |
provider |
string |
trustLevel |
"community" | "official" | "verified" | "experimental" |
Type Declaration¶
| Name | Type |
|---|---|
capabilities |
[{ capability: "create-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObjects: [{ kind: "zendeskTicket"; label: "Zendesk Ticket"; }, { kind: "zendeskTicketComment"; label: "Zendesk Ticket Comment"; }]; requiresCredential: true; sideEffect: true; }, { capability: "read-provider-object"; exposesSensitiveData: true; providerObjects: [{ kind: "zendeskTicket"; label: "Zendesk Ticket"; }, { kind: "zendeskUser"; label: "Zendesk User"; }, { kind: "zendeskOrganization"; label: "Zendesk Organization"; }, { kind: "zendeskWebhook"; label: "Zendesk Webhook"; }]; requiresCredential: true; }, { capability: "update-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObjects: [{ kind: "zendeskTicket"; label: "Zendesk Ticket"; }]; requiresCredential: true; sideEffect: true; }, { capability: "search-provider-object"; exposesSensitiveData: true; providerObjects: [{ kind: "zendeskTicket"; label: "Zendesk Ticket"; }]; requiresCredential: true; }, { capability: "send"; changesWorkflow: true; exposesSensitiveData: true; providerObjects: [{ kind: "zendeskTicketComment"; label: "Zendesk Ticket Comment"; }]; requiresCredential: true; sideEffect: true; }, { capability: "draft"; exposesSensitiveData: true; providerObjects: [{ kind: "zendeskInternalNote"; label: "Zendesk Internal Note"; }]; requiresCredential: true; sideEffect: true; }, { capability: "attach"; changesWorkflow: true; exposesSensitiveData: true; providerObjects: [{ kind: "zendeskTicketAttachment"; label: "Zendesk Ticket Attachment"; }]; requiresCredential: true; sideEffect: true; }, { capability: "handoff"; changesWorkflow: true; exposesSensitiveData: true; providerObjects: [{ kind: "zendeskTicket"; label: "Zendesk Ticket"; }, { kind: "zendeskTicketComment"; label: "Zendesk Ticket Comment"; }]; requiresCredential: true; sideEffect: true; }] |
category |
"ticketing" |
channelAudiences |
["customer-facing", "internal-support", "mixed"] |
coverage |
{ evidence: [{ label: "node-zendesk package"; url: "https://www.npmjs.com/package/node-zendesk"; }, { label: "Zendesk Node.js API client docs"; url: "https://developer.zendesk.com/documentation/ticketing/api-clients/nodejs/"; }, { label: "Zendesk Support API OpenAPI"; url: "https://developer.zendesk.com/zendesk/oas.yaml"; }, { label: "Zendesk Support Tickets API"; url: "https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/"; }, { label: "Zendesk Ticket Comments API"; url: "https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/"; }, { label: "Zendesk Upload Files API"; url: "https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/"; }]; notes: ["Coverage is a Cognidesk support workflow adapter backed by the node-zendesk provider SDK.", "Typed operations cover ticket create/read/update/search, public comments, internal notes, upload-and-attach, users, organizations, webhooks list, current-user readiness, and a node-zendesk rawClient escape hatch for SDK-user-owned advanced methods.", "This package intentionally does not copy the old generated full Zendesk Support OpenAPI clone."]; scope: "support-workflow-subset"; } |
coverage.evidence |
[{ label: "node-zendesk package"; url: "https://www.npmjs.com/package/node-zendesk"; }, { label: "Zendesk Node.js API client docs"; url: "https://developer.zendesk.com/documentation/ticketing/api-clients/nodejs/"; }, { label: "Zendesk Support API OpenAPI"; url: "https://developer.zendesk.com/zendesk/oas.yaml"; }, { label: "Zendesk Support Tickets API"; url: "https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/"; }, { label: "Zendesk Ticket Comments API"; url: "https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/"; }, { label: "Zendesk Upload Files API"; url: "https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/"; }] |
coverage.notes |
["Coverage is a Cognidesk support workflow adapter backed by the node-zendesk provider SDK.", "Typed operations cover ticket create/read/update/search, public comments, internal notes, upload-and-attach, users, organizations, webhooks list, current-user readiness, and a node-zendesk rawClient escape hatch for SDK-user-owned advanced methods.", "This package intentionally does not copy the old generated full Zendesk Support OpenAPI clone."] |
coverage.scope |
"support-workflow-subset" |
credentialRequirements |
[{ id: "zendesk-instance"; label: "Zendesk Support instance URL"; required: true; }, { id: "zendesk-api-access"; label: "Zendesk Support API access"; metadata: { privilegeGuidance: "OAuth tokens use Zendesk read/write scopes. API-token credentials inherit the Zendesk user's role and Support permissions."; scopeKind: "mixed-auth-mode"; }; required: true; scopes: ["read", "write"]; }] |
directions |
["bidirectional"] |
id |
"ticketing.zendesk" |
limitations |
["Tenant fields, triggers, automations, macros, routing, requester identity, and outbound policy remain SDK-user configuration."] |
maintainers |
[{ name: "Cognidesk"; type: "official"; }] |
metadata |
{ channelCoverage: { broaderZendeskApi: "provider-sdk-raw-client"; comments: "sdk-backed-ticket-update-comment"; organizations: "sdk-backed-read"; tickets: "sdk-backed-create-read-update-search"; uploads: "sdk-backed-attachments-upload-and-ticket-comment-association"; users: "sdk-backed-read-current-user"; webhooks: "sdk-backed-list"; }; implementation: { manifestImport: "no-sdk-client-initialization"; rawClientEscapeHatch: "ZendeskTicketingClient.rawClient / getRawClient()"; sdkPackage: "node-zendesk"; sdkVersionRange: "^6.0.1"; strategy: "provider-sdk-backed-client"; }; implementationStrategy: "node-zendesk-sdk-backed-support-workflow-subset"; integrationEntryPoints: { manifest: "@cognidesk/integration-ticketing-zendesk/manifest"; runtime: "@cognidesk/integration-ticketing-zendesk/runtime"; }; integrationName: "Zendesk Integration"; integrationPackageName: "@cognidesk/integration-ticketing-zendesk"; issue: 35; providerClient: { importPolicy: "runtime-entrypoint-only"; package: "node-zendesk"; versionRange: "^6.0.1"; }; } |
metadata.channelCoverage |
{ broaderZendeskApi: "provider-sdk-raw-client"; comments: "sdk-backed-ticket-update-comment"; organizations: "sdk-backed-read"; tickets: "sdk-backed-create-read-update-search"; uploads: "sdk-backed-attachments-upload-and-ticket-comment-association"; users: "sdk-backed-read-current-user"; webhooks: "sdk-backed-list"; } |
metadata.channelCoverage.broaderZendeskApi |
"provider-sdk-raw-client" |
metadata.channelCoverage.comments |
"sdk-backed-ticket-update-comment" |
metadata.channelCoverage.organizations |
"sdk-backed-read" |
metadata.channelCoverage.tickets |
"sdk-backed-create-read-update-search" |
metadata.channelCoverage.uploads |
"sdk-backed-attachments-upload-and-ticket-comment-association" |
metadata.channelCoverage.users |
"sdk-backed-read-current-user" |
metadata.channelCoverage.webhooks |
"sdk-backed-list" |
metadata.implementation |
{ manifestImport: "no-sdk-client-initialization"; rawClientEscapeHatch: "ZendeskTicketingClient.rawClient / getRawClient()"; sdkPackage: "node-zendesk"; sdkVersionRange: "^6.0.1"; strategy: "provider-sdk-backed-client"; } |
metadata.implementation.manifestImport |
"no-sdk-client-initialization" |
metadata.implementation.rawClientEscapeHatch |
"ZendeskTicketingClient.rawClient / getRawClient()" |
metadata.implementation.sdkPackage |
"node-zendesk" |
metadata.implementation.sdkVersionRange |
"^6.0.1" |
metadata.implementation.strategy |
"provider-sdk-backed-client" |
metadata.implementationStrategy |
"node-zendesk-sdk-backed-support-workflow-subset" |
metadata.integrationEntryPoints |
{ manifest: "@cognidesk/integration-ticketing-zendesk/manifest"; runtime: "@cognidesk/integration-ticketing-zendesk/runtime"; } |
metadata.integrationEntryPoints.manifest |
"@cognidesk/integration-ticketing-zendesk/manifest" |
metadata.integrationEntryPoints.runtime |
"@cognidesk/integration-ticketing-zendesk/runtime" |
metadata.integrationName |
"Zendesk Integration" |
metadata.integrationPackageName |
"@cognidesk/integration-ticketing-zendesk" |
metadata.issue |
35 |
metadata.providerClient |
{ importPolicy: "runtime-entrypoint-only"; package: "node-zendesk"; versionRange: "^6.0.1"; } |
metadata.providerClient.importPolicy |
"runtime-entrypoint-only" |
metadata.providerClient.package |
"node-zendesk" |
metadata.providerClient.versionRange |
"^6.0.1" |
name |
"Zendesk Support" |
operations |
[{ alias: "ticket.create"; capability: "create-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "ticket"; providerOperation: "POST /api/v2/tickets.json"; sideEffect: true; }, { alias: "ticket.read"; capability: "read-provider-object"; exposesSensitiveData: true; providerObject: "ticket"; providerOperation: "GET /api/v2/tickets/{ticket_id}.json"; }, { alias: "ticket.update"; capability: "update-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "ticket"; providerOperation: "PUT /api/v2/tickets/{ticket_id}.json"; sideEffect: true; }, { alias: "ticket.search"; capability: "search-provider-object"; exposesSensitiveData: true; providerObject: "ticket"; providerOperation: "GET /api/v2/search.json"; }, { alias: "ticket.comment.create"; capability: "send"; exposesSensitiveData: true; externallyVisible: true; providerObject: "ticketComment"; providerOperation: "PUT /api/v2/tickets/{ticket_id}.json"; sideEffect: true; }, { alias: "ticket.internalNote.create"; capability: "draft"; exposesSensitiveData: true; providerObject: "internalNote"; providerOperation: "PUT /api/v2/tickets/{ticket_id}.json"; sideEffect: true; }, { alias: "ticket.attachments.add"; capability: "attach"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "attachment"; providerOperation: "POST /api/v2/uploads.json + PUT /api/v2/tickets/{ticket_id}.json"; sideEffect: true; }, { alias: "customer.read"; capability: "read-provider-object"; exposesSensitiveData: true; providerObject: "customer"; providerOperation: "GET /api/v2/users/{user_id}.json"; }, { alias: "zendesk.organization.read"; capability: "read-provider-object"; exposesSensitiveData: true; extension: true; providerObject: "zendeskOrganization"; providerOperation: "GET /api/v2/organizations/{organization_id}.json"; }, { alias: "zendesk.webhook.list"; capability: "search-provider-object"; exposesSensitiveData: true; extension: true; providerObject: "zendeskWebhook"; providerOperation: "GET /api/v2/webhooks"; }, { alias: "zendesk.readiness"; capability: "read-provider-object"; exposesSensitiveData: true; extension: true; providerObject: "zendeskCurrentUser"; providerOperation: "GET /api/v2/users/me.json"; }] |
packageName |
"@cognidesk/integration-ticketing-zendesk" |
privacyNotes |
["Zendesk tickets can contain customer messages, requester details, internal comments, tags, and workflow metadata."] |
provider |
"zendesk" |
trustLevel |
"official" |
zendeskTicketingProviderManifestInput¶
const zendeskTicketingProviderManifestInput: {
capabilities: [{
capability: "create-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}, {
kind: "zendeskTicketComment";
label: "Zendesk Ticket Comment";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "read-provider-object";
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}, {
kind: "zendeskUser";
label: "Zendesk User";
}, {
kind: "zendeskOrganization";
label: "Zendesk Organization";
}, {
kind: "zendeskWebhook";
label: "Zendesk Webhook";
}];
requiresCredential: true;
}, {
capability: "update-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "search-provider-object";
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}];
requiresCredential: true;
}, {
capability: "send";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicketComment";
label: "Zendesk Ticket Comment";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "draft";
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskInternalNote";
label: "Zendesk Internal Note";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "attach";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicketAttachment";
label: "Zendesk Ticket Attachment";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "handoff";
changesWorkflow: true;
exposesSensitiveData: true;
providerObjects: [{
kind: "zendeskTicket";
label: "Zendesk Ticket";
}, {
kind: "zendeskTicketComment";
label: "Zendesk Ticket Comment";
}];
requiresCredential: true;
sideEffect: true;
}];
category: "ticketing";
channelAudiences: ["customer-facing", "internal-support", "mixed"];
coverage: {
evidence: [{
label: "node-zendesk package";
url: "https://www.npmjs.com/package/node-zendesk";
}, {
label: "Zendesk Node.js API client docs";
url: "https://developer.zendesk.com/documentation/ticketing/api-clients/nodejs/";
}, {
label: "Zendesk Support API OpenAPI";
url: "https://developer.zendesk.com/zendesk/oas.yaml";
}, {
label: "Zendesk Support Tickets API";
url: "https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/";
}, {
label: "Zendesk Ticket Comments API";
url: "https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/";
}, {
label: "Zendesk Upload Files API";
url: "https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/";
}];
notes: ["Coverage is a Cognidesk support workflow adapter backed by the node-zendesk provider SDK.", "Typed operations cover ticket create/read/update/search, public comments, internal notes, upload-and-attach, users, organizations, webhooks list, current-user readiness, and a node-zendesk rawClient escape hatch for SDK-user-owned advanced methods.", "This package intentionally does not copy the old generated full Zendesk Support OpenAPI clone."];
scope: "support-workflow-subset";
};
credentialRequirements: [{
id: "zendesk-instance";
label: "Zendesk Support instance URL";
required: true;
}, {
id: "zendesk-api-access";
label: "Zendesk Support API access";
metadata: {
privilegeGuidance: "OAuth tokens use Zendesk read/write scopes. API-token credentials inherit the Zendesk user's role and Support permissions.";
scopeKind: "mixed-auth-mode";
};
required: true;
scopes: ["read", "write"];
}];
directions: ["bidirectional"];
id: "ticketing.zendesk";
limitations: ["Tenant fields, triggers, automations, macros, routing, requester identity, and outbound policy remain SDK-user configuration."];
maintainers: [{
name: "Cognidesk";
type: "official";
}];
metadata: {
channelCoverage: {
broaderZendeskApi: "provider-sdk-raw-client";
comments: "sdk-backed-ticket-update-comment";
organizations: "sdk-backed-read";
tickets: "sdk-backed-create-read-update-search";
uploads: "sdk-backed-attachments-upload-and-ticket-comment-association";
users: "sdk-backed-read-current-user";
webhooks: "sdk-backed-list";
};
implementation: {
manifestImport: "no-sdk-client-initialization";
rawClientEscapeHatch: "ZendeskTicketingClient.rawClient / getRawClient()";
sdkPackage: "node-zendesk";
sdkVersionRange: "^6.0.1";
strategy: "provider-sdk-backed-client";
};
implementationStrategy: "node-zendesk-sdk-backed-support-workflow-subset";
integrationEntryPoints: {
manifest: "@cognidesk/integration-ticketing-zendesk/manifest";
runtime: "@cognidesk/integration-ticketing-zendesk/runtime";
};
integrationName: "Zendesk Integration";
integrationPackageName: "@cognidesk/integration-ticketing-zendesk";
issue: 35;
providerClient: {
importPolicy: "runtime-entrypoint-only";
package: "node-zendesk";
versionRange: "^6.0.1";
};
};
name: "Zendesk Support";
operations: [{
alias: "ticket.create";
capability: "create-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "ticket";
providerOperation: "POST /api/v2/tickets.json";
sideEffect: true;
}, {
alias: "ticket.read";
capability: "read-provider-object";
exposesSensitiveData: true;
providerObject: "ticket";
providerOperation: "GET /api/v2/tickets/{ticket_id}.json";
}, {
alias: "ticket.update";
capability: "update-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "ticket";
providerOperation: "PUT /api/v2/tickets/{ticket_id}.json";
sideEffect: true;
}, {
alias: "ticket.search";
capability: "search-provider-object";
exposesSensitiveData: true;
providerObject: "ticket";
providerOperation: "GET /api/v2/search.json";
}, {
alias: "ticket.comment.create";
capability: "send";
exposesSensitiveData: true;
externallyVisible: true;
providerObject: "ticketComment";
providerOperation: "PUT /api/v2/tickets/{ticket_id}.json";
sideEffect: true;
}, {
alias: "ticket.internalNote.create";
capability: "draft";
exposesSensitiveData: true;
providerObject: "internalNote";
providerOperation: "PUT /api/v2/tickets/{ticket_id}.json";
sideEffect: true;
}, {
alias: "ticket.attachments.add";
capability: "attach";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "attachment";
providerOperation: "POST /api/v2/uploads.json + PUT /api/v2/tickets/{ticket_id}.json";
sideEffect: true;
}, {
alias: "customer.read";
capability: "read-provider-object";
exposesSensitiveData: true;
providerObject: "customer";
providerOperation: "GET /api/v2/users/{user_id}.json";
}, {
alias: "zendesk.organization.read";
capability: "read-provider-object";
exposesSensitiveData: true;
extension: true;
providerObject: "zendeskOrganization";
providerOperation: "GET /api/v2/organizations/{organization_id}.json";
}, {
alias: "zendesk.webhook.list";
capability: "search-provider-object";
exposesSensitiveData: true;
extension: true;
providerObject: "zendeskWebhook";
providerOperation: "GET /api/v2/webhooks";
}, {
alias: "zendesk.readiness";
capability: "read-provider-object";
exposesSensitiveData: true;
extension: true;
providerObject: "zendeskCurrentUser";
providerOperation: "GET /api/v2/users/me.json";
}];
packageName: "@cognidesk/integration-ticketing-zendesk";
privacyNotes: ["Zendesk tickets can contain customer messages, requester details, internal comments, tags, and workflow metadata."];
provider: "zendesk";
trustLevel: "official";
};