Skip to content

Main Navigation Home Guide API Example

Appearance

Sidebar Navigation

README

clients

authorization handler

clients/authorization handler

classes

Class: AuthorizationHandler

client

clients/client

classes

Class: Client

type aliases

Type Alias: ClientOptions

Type Alias: ZendeskClientOptions

core

accountsettings

clients/core/accountsettings

classes

Class: AccountSettings

activitystream

clients/core/activitystream

classes

Class: ActivityStream

attachments

clients/core/attachments

classes

Class: Attachments

automations

clients/core/automations

classes

Class: Automations

brand

clients/core/brand

classes

Class: Brands

type aliases

Type Alias: Brand

Type Alias: CreateOrUpdateBrand

customagentroles

clients/core/customagentroles

classes

Class: CustomAgentRoles

dynamiccontent

clients/core/dynamiccontent

classes

Class: DynamicContent

dynamiccontentvariants

clients/core/dynamiccontentvariants

classes

Class: DynamicContentVariants

groupmemberships

clients/core/groupmemberships

classes

Class: GroupMemberships

groups

clients/core/groups

classes

Class: Groups

type aliases

Type Alias: CreateOrUpdateGroup

Type Alias: Group

Type Alias: RecursivePartial\

imports

clients/core/imports

classes

Class: Imports

installations

clients/core/installations

classes

Class: Installations

jobstatuses

clients/core/jobstatuses

classes

Class: JobStatuses

locales

clients/core/locales

classes

Class: Locales

macros

clients/core/macros

classes

Class: Macros

type aliases

Type Alias: CreateOrUpdateMacro

Type Alias: Macro

Type Alias: RecursivePartial\

oauthclients

clients/core/oauthclients

classes

Class: OAuthClients

oauthtokens

clients/core/oauthtokens

classes

Class: OAuthTokens

organizationfields

clients/core/organizationfields

classes

Class: OrganizationFields

organizationmemberships

clients/core/organizationmemberships

classes

Class: OrganizationMemberships

organizations

clients/core/organizations

classes

Class: Organizations

type aliases

Type Alias: CreateManyOrganizations

Type Alias: CreateOrganization

Type Alias: Organization

Type Alias: OrganizationRelatedResponse

Type Alias: UpdateManyOrganizations

Type Alias: UpdateOrganization

Type Alias: UpdateOrganizationWithId

permissiongroups

clients/core/permissiongroups

classes

Class: PermissionGroups

policies

clients/core/policies

classes

Class: Policies

requests

clients/core/requests

classes

Class: Requests

satisfactionratings

clients/core/satisfactionratings

classes

Class: SatisfactionRatings

search

clients/core/search

classes

Class: Search

sessions

clients/core/sessions

classes

Class: Sessions

sharingagreement

clients/core/sharingagreement

classes

Class: SharingAgreement

sideconversations

clients/core/sideconversations

classes

Class: SideConversations

type aliases

Type Alias: CreateSideConversation

Type Alias: Message

Type Alias: Participant

Type Alias: SideConversation

Type Alias: SideConversationAttachment

Type Alias: SideConversationResponse

Type Alias: UpdateSideConversation

suspendedtickets

clients/core/suspendedtickets

classes

Class: SuspendedTickets

tags

clients/core/tags

classes

Class: Tags

targetfailures

clients/core/targetfailures

classes

Class: TargetFailures

targets

clients/core/targets

classes

Class: Targets

ticketaudits

clients/core/ticketaudits

classes

Class: TicketAudits

ticketevents

clients/core/ticketevents

classes

Class: TicketEvents

ticketexport

clients/core/ticketexport

classes

Class: TicketExport

ticketfields

clients/core/ticketfields

classes

Class: TicketFields

type aliases

Type Alias: TicketField

ticketforms

clients/core/ticketforms

classes

Class: TicketForms

ticketimport

clients/core/ticketimport

classes

Class: TicketImport

ticketmetrics

clients/core/ticketmetrics

classes

Class: TicketMetrics

tickets

clients/core/tickets

classes

Class: Tickets

type aliases

Type Alias: Attachment

Type Alias: CreateManyTickets

Type Alias: CreateOrUpdateTicket

Type Alias: CustomField

Type Alias: Priority

Type Alias: RecursivePartial\

Type Alias: Status

Type Alias: Ticket

Type Alias: TicketCollaborator

Type Alias: TicketComment

Type Alias: Type

Type Alias: Via

triggers

clients/core/triggers

classes

Class: Triggers

userfields

clients/core/userfields

classes

Class: UserFields

useridentities

clients/core/useridentities

classes

Class: UserIdentities

users

clients/core/users

classes

Class: Users

type aliases

Type Alias: User

views

clients/core/views

classes

Class: Views

webhooks

clients/core/webhooks

classes

Class: Webhooks

type aliases

Type Alias: CreateOrUpdateWebhook

Type Alias: Webhook

Type Alias: WebhookSigningSecret

custom event target

clients/custom event target

classes

Class: CustomEventTarget

endpoint checker

clients/endpoint checker

classes

Class: EndpointChecker

helpcenter

clients/helpcenter

accesspolicies

clients/helpcenter/accesspolicies

classes

Class: AccessPolicies

articleattachments

clients/helpcenter/articleattachments

classes

Class: ArticleAttachments

articlecomments

clients/helpcenter/articlecomments

classes

Class: ArticleComments

articlelabels

clients/helpcenter/articlelabels

classes

Class: ArticleLabels

articles

clients/helpcenter/articles

classes

Class: Articles

type aliases

Type Alias: Article

categories

clients/helpcenter/categories

classes

Class: Categories

type aliases

Type Alias: Category

classes

Class: ZendeskClientHelpcenter

search

clients/helpcenter/search

classes

Class: Search

sections

clients/helpcenter/sections

classes

Class: Sections

subscriptions

clients/helpcenter/subscriptions

classes

Class: Subscriptions

translations

clients/helpcenter/translations

classes

Class: Translations

usersegments

clients/helpcenter/usersegments

classes

Class: UserSegments

votes

clients/helpcenter/votes

classes

Class: Votes

helpers

clients/helpers

functions

Function: assembleUrl()

Function: checkRequestResponse()

Function: flatten()

Function: generateUserAgent()

Function: processResponseBody()

job monitor

clients/job monitor

classes

Class: export=

services

clients/services

classes

Class: ZendeskClientServices

links

clients/services/links

classes

Class: Links

throttle

clients/throttle

functions

Function: export=()

transporter

clients/transporter

classes

Class: Transporter

voice

clients/voice

agentactivity

clients/voice/agentactivity

classes

Class: AgentActivity

availabilities

clients/voice/availabilities

classes

Class: Availabilities

classes

Class: ZendeskClientVoice

currentqueueactivity

clients/voice/currentqueueactivity

classes

Class: CurrentQueueActivity

greetingcategories

clients/voice/greetingcategories

classes

Class: GreetingCategories

greetings

clients/voice/greetings

classes

Class: Greetings

historicalqueueactivity

clients/voice/historicalqueueactivity

classes

Class: HistoricalQueueActivity

phonenumbers

clients/voice/phonenumbers

classes

Class: PhoneNumbers

constants

constants

namespaces

ApiTypes

ApiTypes

variables

Variable: core

Variable: helpcenter

Variable: services

Variable: voice

type aliases

Type Alias: ApiTypes

variables

Variable: Endpoints

index

index

classes

Class: ZendeskClient

functions

Function: createClient()

type aliases

Type Alias: ZendeskClientOptions

logger

logger

classes

Class: export=

node zendesk

On this page

node-zendesk • Docs

node-zendesk / clients/client / ZendeskClientOptions

Type Alias: ZendeskClientOptions

ZendeskClientOptions: index

Defined in

clients/client.d.ts:1

Pager

Previous pageType Alias: ClientOptions

Next pageclients/core/accountsettings

Released under the MIT License.

Copyright © 2012-present | Made by Farrin A. Reid with ❤️