npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@o2s/integrations.zendesk

v3.1.4

Published

Zendesk integration for O2S, providing ticket management and support functionality.

Downloads

455

Readme

@o2s/integrations.zendesk

Zendesk integration for O2S, providing ticket management and support functionality.

The Zendesk integration connects O2S to both Zendesk Support (ticketing) and Zendesk Help Center (articles). For tickets: search by requester email, get single ticket, create tickets with attachments, and map custom fields. For articles: get article, list articles, categories, and full-text search via Help Center API. Ticket and article data are scoped to the logged-in user.

  • Tickets – Search, create, view, attachments; custom field mapping
  • Articles – Articles, categories, search (knowledge base)
  • Custom forms – Contact, complaint, device maintenance forms via env vars
  • OpenAPI-generated clients – Type-safe Zendesk API usage

Content editors manage tickets and articles in Zendesk. Developers configure ZENDESK_API_URL, ZENDESK_API_TOKEN, and optional custom field IDs.

Installation

npm install @o2s/integrations.zendesk

Configuration

Configure the integration via @o2s/configs.integrations in your AppConfig:

import { Tickets } from '@o2s/configs.integrations';
import { ZendeskConfig } from '@o2s/integrations.zendesk/integration';

export const AppConfig: ApiConfig = {
    integrations: {
        tickets: ZendeskConfig.tickets,
    },
};

Or use the pre-configured integration from @o2s/configs.integrations:

import { Tickets } from '@o2s/configs.integrations';

export const AppConfig: ApiConfig = {
    integrations: {
        tickets: Tickets.TicketsIntegrationConfig,
    },
};

Environment Variables

Required

  • ZENDESK_API_URL - Your Zendesk API URL (e.g., https://your-domain.zendesk.com)
  • ZENDESK_API_TOKEN - Zendesk API token for authentication

Optional

The following environment variables are optional and used for custom field mapping:

  • ZENDESK_CONTACT_FORM_ID - Contact form ID
  • ZENDESK_COMPLAINT_FORM_ID - Complaint form ID
  • ZENDESK_REQUEST_DEVICE_MAINTENANCE_FORM_ID - Device maintenance form ID
  • ZENDESK_TOPIC_FIELD_ID - Topic custom field ID
  • ZENDESK_TERMS_ACCEPTANCE_FIELD_ID - Terms acceptance field ID
  • ZENDESK_NEWSLETTER_CONSENT_FIELD_ID - Newsletter consent field ID
  • ZENDESK_MARKETING_CONSENT_FIELD_ID - Marketing consent field ID
  • ZENDESK_EMAIL_FIELD_ID - Email custom field ID
  • ZENDESK_INVOICE_NUMBER_FIELD_ID - Invoice number field ID
  • ZENDESK_DEVICE_NAME_FIELD_ID - Device name field ID
  • ZENDESK_SERIAL_NUMBER_FIELD_ID - Serial number field ID
  • ZENDESK_MAINTENANCE_TYPE_FIELD_ID - Maintenance type field ID
  • ZENDESK_MAINTENANCE_PREFERRED_DATE_FIELD_ID - Preferred maintenance date field ID
  • ZENDESK_ADDITIONAL_NOTES_FIELD_ID - Additional notes field ID
  • ZENDESK_CONTACT_FIELD_ID - Contact information field ID
  • ZENDESK_ISSUE_DATE_FIELD_ID - Issue date field ID
  • ZENDESK_COMPANY_NAME_FIELD_ID - Company name field ID
  • ZENDESK_FIRST_NAME_FIELD_ID - First name field ID
  • ZENDESK_LAST_NAME_FIELD_ID - Last name field ID
  • ZENDESK_PHONE_FIELD_ID - Phone field ID
  • ZENDESK_ADDRESS_FIELD_ID - Address field ID
  • ZENDESK_INQUIRY_TYPE_FIELD_ID - Inquiry type field ID
  • ZENDESK_PRODUCT_CATEGORY_FIELD_ID - Product category field ID
  • ZENDESK_PREFERRED_CONTACT_METHOD_FIELD_ID - Preferred contact method field ID

Example .env

ZENDESK_API_URL=https://your-domain.zendesk.com
ZENDESK_API_TOKEN=your-api-token-here
ZENDESK_CONTACT_FORM_ID=12345
ZENDESK_TOPIC_FIELD_ID=67890

Features

  • Ticket creation and management
  • Ticket comments and replies
  • User lookup and management
  • Custom field mapping
  • Support for multiple ticket forms

Related Packages

  • @o2s/blocks.ticket-list - Display list of tickets
  • @o2s/blocks.ticket-details - Display ticket details
  • @o2s/configs.integrations - Integration configuration

About Integrations in O2S

Integrations are adapters that connect O2S to external backend services. They handle API communication and normalize data from various backend services into an API-agnostic format. The frontend app communicates only with the API Harmonization server, never directly with backend services, enabling you to swap integrations without breaking the frontend.

Documentation - For Zendesk integration, see both areas:

About O2S

Part of Open Self Service (O2S) - an open-source framework for building composable customer self-service portals. O2S simplifies integration of multiple headless APIs into a scalable frontend, providing an API-agnostic architecture with a normalization layer.