# Zendesk > API Basics | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / API Basics Home --- # Source: https://developer.zendesk.com/documentation/api-basics/ API Basics | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / API Basics Home - - ## API Basics - Introduction - - ### Getting Started - About the Zendesk developer platform - Getting a trial or sponsored account for development - Zendesk API resources - Installing and using curl - Exploring Zendesk APIs with Postman - Frequently asked questions - REST API glossary - - ### Best practices - Best practices for avoiding rate limiting - Using audit logs to track activity - Using events to automate interactions - Working with url properties - Security best practices - - ### Working With Data - Working with JSON - Using the Search API - Understanding sideloading - Side-loading related records - Getting large data sets with the Zendesk API and Python - Writing large data sets to Excel with Python and pandas - Using the Incremental Exports API - Exporting users with the Zendesk API - Importing users with the Zendesk API - Exporting access logs to a CSV file - - ### Pagination - Comparing cursor pagination and offset pagination - Paginating through lists using cursor pagination - Paginating through lists using offset pagination - Paginating through lists - Understanding the limitations of offset pagination - - ### Authentication - Understanding the differences between API tokens and OAuth access tokens - Using OAuth to authenticate Zendesk API requests in a web app - Creating and using OAuth tokens with the API - Getting information about OAuth access tokens - Revoking an OAuth access token - Using PKCE to make Zendesk OAuth access tokens more secure - Using the API when SSO or two-factor authentication is enabled ## On this page - Getting started - Working with the Zendesk APIs # API Basics Supercharge your workflows using the Zendesk APIs ## On this page - Getting started - Working with the Zendesk APIs ## Getting started Getting a trial or sponsored account for development You can try out the Zendesk platform with a free, 14-day trial account. If you're interested in becoming a Zendesk developer partner, you can convert your trial account into a sponsored Zendesk Support account. Installing and using curl All the examples in the Zendesk REST API docs use curl, a lightweight, command-line tool for making HTTP requests without a web browser. curl lets you try out various API requests in a command-line interface such as the command prompt in Windows or Terminal in macOS. Working with JSON The Zendesk REST API is a JSON API. If you want to send data to the API to update or create data in your Zendesk product, you need to convert it to JSON first. This guide covers the basics and how to use JSON in curl statements. Developer updates Stay up to date with the latest announcements. Changelog View breaking changes and other significant changes and additions to Zendesk APIs and SDKs. ## Working with the Zendesk APIs Making requests to the Ticketing API Use the Zendesk Ticketing API to read, update, and create data in Zendesk Support. This tutorial shows you how to start working with the API with examples of completing common tasks. Exploring Zendesk APIs with Postman Postman is a popular application for testing APIs. This article explains how to set up Postman to make Zendesk API requests. Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status --- # Source: https://developer.zendesk.com/documentation/apps/ Apps | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / Apps Home - - ## Apps - Introduction - - ### Getting Started - Overview - Zendesk app quick start - Test drive the Apps framework - Using the Zendesk Command Line Interface (ZCLI) - Choose your own app adventure - Setting up new apps - Uploading and installing a private app - Glossary - Zendesk apps resources - Building apps with App Builder and generative AI - - ### App Developer Guide - Getting started - Using the Apps framework - Making API requests from a Zendesk app - Specifying app requirements - Working with multi-product apps - Styles and assets - Supporting dark mode - Deploying apps - Manifest reference - Best practices for Zendesk apps developers - Creating and managing private apps with the Zendesk API - About the Zendesk React app scaffold - Known app limitations - Framework versions - Managing global OAuth clients and app associations - - ### Build An App - Building your first Support app - Building your first Support app - Part 1: Laying the groundwork - Building your first Support app - Part 2: Designing the user interface - Building your first Support app - Part 3: Creating and inserting templates - Building your first Support app - Part 4: Getting data - Building your first Support app - Part 5: Installing the app in Zendesk Support - Building your first Sell app - Building your first Sell app - Part 1: Laying the groundwork - Building your first Sell app - Part 2: Designing the user interface - Building your first Sell app - Part 3: Creating and inserting templates - Building your first Sell app - Part 4: Getting data - Building your first Sell app - Part 5: Installing the app in Zendesk Sell - Building your first Chat app - Building your first Chat app - Part 1: Laying the groundwork - Building your first Chat app - Part 2: Designing the user interface - Building your first Chat app - Part 3: Creating and inserting templates - Building your first Chat app - Part 4: Getting data - Building your first Chat app - Part 5: Installing the app in Zendesk Chat - Building a Support ticket editor app - Localizing a Support app - Adding third-party OAuth to a Support app - Using React in a Support app - Dynamically changing app icons - Using AI to summarize conversations in a Support app - Using the Zendesk developer platform to let support agents process exchanges and refunds - Using the Zendesk developer platform to give support agents a unified view of the customer - Building a server-side app - Building a server-side app - Part 1: Core concepts - Building a server-side app - Part 2: Displaying server-side content in a Zendesk app - Building a server-side app - Part 3: Accessing external APIs - Building a server-side app - Part 4: Accessing framework APIs - Building a server-side app - Part 5: Securing the app - Building a server-side app - Part 6: Deploying the app - How a custom objects app is built for Sell - Building a Sell app using OAuth 2.0 - Building a Sell app using OAuth 2.0 - Part 1: Laying the groundwork - Building a Sell app using OAuth 2.0 - Part 2: Installing the app in Zendesk Sell - Building a Sell app using OAuth 2.0 - Part 3: Setting up OAuth 2.0 - Building a Sell app using OAuth 2.0 - Part 4: Creating audiences in Mailchimp - Building a Sell app using OAuth 2.0 - Part 5: Getting data from the Mailchimp API - Create a CI/CD pipeline for a Zendesk app - - ### Designing Your App - UI Fundamentals - Designing with Zendesk Garden - Support app locations - Sidebar apps - Top bar apps - Sell app locations - Sidebar apps - Chat app locations - Sidebar apps - - ### Zendesk Apps Tools (ZAT) - Installing and using ZAT - ZAT commands - ZAT - Known issues ## On this page - Learn about the different apps you can build - Getting started - Building your first app - Publish your app to the Zendesk Marketplace # Apps Build and publish apps for Support, Sell and Chat ## On this page - Learn about the different apps you can build - Getting started - Building your first app - Publish your app to the Zendesk Marketplace ## Learn about the different apps you can build You may have already read about the Zendesk Apps framework (ZAF) and how you can use it to modify and extend your agent's interface in a number of ways. But are you aware of all the paths that you can choose when starting your custom code adventure? Know the benefits of each approach, so you can determine what direction is best. Choose your own app adventure ## Getting started Build an app with App Builder Create Zendesk apps with natural language prompts and AI, no code required. Zendesk app quick start In this quick start, you'll build and locally run a Zendesk app. The quick start introduces you to the tools and workflow commonly used for Zendesk app development. Test drive the Apps framework In this 15-minute tutorial, you'll use the Zendesk Apps framework to access ticket data. You'll also use the framework to add a comment to a ticket as well as create a ticket. Using the Zendesk Command Line Interface (ZCLI) Install ZCLI, a local development tool that lets you test, validate and package Zendesk apps. ## Building your first app We’ve created step by step tutorials on creating your first Support, Sell, Chat and server-side apps. Building your first Support app The “Requester X-ray” app will display the requester's name, any user tags applied to the requester, when the requester was added and when they last signed in to Zendesk Support. Building your first Sell app The “Related Leads” app displays new leads for an organization associated with a deal. Building your first Chat app The app “Learn More” is designed to let a chat agent send a visitor links to more information about any subject. It'll have a simple interface consisting of a search box and button. Building your first server-side app Because a Zendesk app runs in an iframe in the product, you can use a server-side web application to generate the content for the iframe. You can use any server-side technology you want so long as you have a component that can send HTML pages in response to HTTP requests. ## Publish your app to the Zendesk Marketplace By now, you've either already created an app or are considering building one. The steps in this guide will take you through the process of publishing your app and becoming a Zendesk Marketplace partner. Get started Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status --- # Source: https://developer.zendesk.com/api-reference/conversations/ API Reference | Sunshine Conversations --- # Source: https://developer.zendesk.com/documentation/custom-data/ Custom data | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / Custom Data Home - - ## Custom Data - Introduction - - ### Custom objects - Getting started with custom objects - Creating custom objects - Using custom objects in triggers - Searching and filtering custom object records - Retrieving lookup relationship data with the API - Leveraging custom objects for real-time, data-driven decisions and personalized customer experience - - ### Legacy Custom Objects - Getting started with legacy custom objects - Legacy custom objects handbook - Searching legacy object records - Creating a schema for a legacy custom object - Building a custom API from scratch with legacy custom objects - Schema validation reference for legacy object types - - ### Migrating Legacy Custom Objects - Legacy custom objects migration guide - Migrating legacy custom objects to the new custom objects experience - Example: Migrating legacy custom objects without relationships - Example: Migrating legacy custom objects with relationships - Step 1: Migrating the object types of legacy custom objects - Step 2: Migrating the schemas of legacy custom objects - Step 3: Migrating the relationship types of legacy custom object - Step 4: Migrating the records of legacy custom objects - Step 5: Migrating the relationship records of legacy custom objects ## On this page - What are the custom data APIs? - Custom objects - Legacy Custom Objects # Custom data Seamlessly integrate custom data in Zendesk ## On this page - What are the custom data APIs? - Custom objects - Legacy Custom Objects ## What are the custom data APIs? The Zendesk custom object APIs lets you connect your business's unique data into your Zendesk workflows. These APIs are independent from other Zendesk customer service tools such as the product APIs, the Apps framework, and the Web Widget. ## Custom objects Create custom objects to capture, model, and retrieve almost any data that doesn't fit into the standard Zendesk objects (tickets, users, and organizations). You can model relationships with standard Support objects and other custom objects, and then integrate your custom data with tickets, triggers, Explore analytics, integrations, and the Zendesk Apps framework. To get started with custom objects, see: Getting started with custom objects Custom Objects API reference ## Legacy Custom Objects Existing Zendesk customers might be using the Legacy Custom Objects API to model, store, and retrieve objects that are not native to Zendesk. The data is stored in the Amazon AWS infrastructure. Legacy custom objects can be almost anything, including products, orders, devices, and warranties. If you're new to custom data in Zendesk, see Custom objects . For resources on legacy custom objects, see: Getting started with legacy custom objects Legacy Custom Objects API reference You may also be interested in using the Events and Profiles APIs, which are compatible with legacy custom objects. For more information, see the Events API and Profiles API . Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status --- # Source: https://developer.zendesk.com/documentation/help_center/ Help Center | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / Help Center Home - - ## Help Center - Introduction - - ### Help Center API - Listing the followers of a KB section with the Help Center API - Backing up your knowledge base with the Help Center API - Using the Help Center API to manage article translations - Understanding incremental article exports - Adding KB search to your website with AJAX - Making secured API requests from a help center - Uploading a media file to your help center article - Tutorial: Building a help center integration - Tutorial: Using webhooks with help center events - Help Center API limitations with content blocks ## On this page - Managing your help center content - Customizing help center themes - Embed and extend your help center - Add the Web Widget to your help center - Add help center content to your mobile app # Help Center Customize your help center and knowledge base experience ## On this page - Managing your help center content - Customizing help center themes - Embed and extend your help center - Add the Web Widget to your help center - Add help center content to your mobile app ## Managing your help center content Backing up your knowledge base with the Zendesk API Use the Zendesk REST API to make backup copies of all the articles in your knowledge base. The backups can be useful in case you need to check or revert to a previous version of an article. Listing the followers of a KB section with the Zendesk API Users can subscribe to (or follow) a section in the knowledge base, but the help center doesn't list the section followers. This tutorial describes how to use the API to list the followers of a specified section in your knowledge base. Adding KB search to your website with AJAX The help center provides users with search boxes to find articles in the knowledge base. You might still want users to search the KB from your main website or web application without having to jump out to the help center site. This article describes how to let users search your knowledge base from your website using standard JavaScript and AJAX. Using the help center API to manage article translations This article describes how to download content in your help center so you can hand it off to a localization vendor for translation. You'll also learn how to automate the reverse process: publishing the translated content on the help center after it comes back from the translators. ## Customizing help center themes A help center theme consists of various components, such as HTML, CSS, and JavaScript files that control the visual presentation, layout, and interactivity of the help center. By customizing a theme, businesses can tailor the look and feel of their help center to match their brand identity, improve navigation, and enhance the user experience. You can customize a theme in your favorite code editor locally and preview your changes live in a web browser. Learn more about local theme previewing in Zendesk help Each theme consists of a collection of editable templates that define the layout of different types of pages in the help center. The help center templating language is named Curlybars and implements a large subset of the Handlebars language. Learn more about Curlybars templating language ## Embed and extend your help center ### Add the Web Widget to your help center Add the Web Widget to appear on some or all pages of your help center. Visit Web Widget ### Add help center content to your mobile app The Support SDKs for iOS and Android lets you give users the ability to browse and search your help center knowledge base in the app without using the mobile web browser. Learn about the SDK and how to enable this feature. Visit Mobile SDKs Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status --- # Source: https://developer.zendesk.com/documentation/integration-services/ Zendesk Integration Services | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / Integration Services Home - - ## Integration Services - Introduction - - ### Getting Started - Understanding Zendesk Integration Services - Anatomy of a ZIS bundle - Understanding ZIS capabilities for building an integration - ZIS Frequently Asked Questions (FAQs) - - ### Developer Guide - Developing private ZIS integrations - ZIS flow states - Understanding flow states - Action state - ZIS built-in actions - ZIS custom actions - Choice state - Fail state - Map state - Pass state - Succeed state - Wait state - Flow states retry and error handling - Encoding URL Parameters - jq cheat sheet - ZIS configs - Connections - Understanding connections - Creating and managing OAuth connections - ZIS links - Security best practices for ZIS integrations - Fixing common ZIS errors - Glossary - - ### Integration design guidelines - Introduction - Understanding the admin user journey - Designing your installation and OAuth flow for a private integration - Designing configuration pages - Designing an uninstall flow - - ### Zendesk Integration Services examples - ZIS action: Converting a number to a string - ZIS action: Getting the current date - ZIS bundle: Adding a Choice state - ZIS bundle: Creating an HTTP request body using jq - ZIS bundle: Parsing and sending an event to an external API - ZIS bundle: Posting a message in Slack when the ticket status changes - - ### Zendesk Integration Services tutorials - Getting started - Building your first ZIS integration - Using a ZIS action to make authenticated API requests - Using conditional branching in a ZIS flow - Transforming data in a ZIS flow - Iterating over a collection in a ZIS flow - Using ZIS Links - Using ZIS inbound webhooks - Kicking off a ZIS flow with user activity events - Using JWTs to verify requests from ZIS - Zendesk app as an admin interface - Part 1: Build a Zendesk app with OAuth - Part 2: Connect to Slack - Part 3: Add a configuration UI - Part 4: Install the integration ## On this page - What is Zendesk Integration Services (ZIS)? - Getting started - Reference information # Zendesk Integration Services Build and run an integration ## On this page - What is Zendesk Integration Services (ZIS)? - Getting started - Reference information ## What is Zendesk Integration Services (ZIS)? ZIS is a set of Zendesk-hosted web services that let you integrate Zendesk with other systems and applications. ZIS powers Conversational Data Orchestration, a feature set for automating workflows based on events. ZIS reduces or eliminates the need to build and host middleware for integration features such as: - Ingesting webhooks from an external system - Executing business logic in response to events - Making API calls into Zendesk and the external system - Obtaining and managing authentication tokens - Storing configuration settings - Storing metadata about related objects in Zendesk and the external system ZIS simplifies the process to build and run private integrations. ## Getting started Understanding Zendesk Integration Services Learn about ZIS services and the resources used to build an integration. Anatomy of a ZIS bundle Learn how a ZIS bundle is a declaration of your resources in an integration. Building your first ZIS integration Get hands-on. This tutorial shows you how to build your first ZIS integration from scratch and run it. Designing an integration Learn about designing your installation and OAuth flow for your integration. ZIS Frequently Asked Questions Find answers to common questions about ZIS. Introduction to ZIS Learn the key features of ZIS in this free, on-demand training course. ## Reference information Refer to the ZIS APIs to build your integration and the Trigger events schema when designing an integration to respond to Zendesk events. ZIS APIs Trigger events reference Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status --- # Source: https://developer.zendesk.com/documentation/live-chat/ Live Chat | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / Live Chat Home - - ## Live Chat - Introduction - - ### Getting Started - OAuth Authentication - Getting started with the Chat Conversations API ## On this page - Enable your app to act as a Zendesk Chat agent - Embed and extend Chat - Add Chat to your website or help center - Build apps for Chat # Live Chat Enable your app to act as a Zendesk Chat agent ## On this page - Enable your app to act as a Zendesk Chat agent - Embed and extend Chat - Add Chat to your website or help center - Build apps for Chat ## Enable your app to act as a Zendesk Chat agent The Chat Conversations API allows your application to act as a Zendesk Chat agent and interact with your website visitors.The API uses the GraphQL data query language to give you more flexibility. Getting started with the Chat Conversations API ## Embed and extend Chat ### Add Chat to your website or help center In this article, we’ll walk you through the tasks you need to complete to make chat available to your customers on your website using the Web Widget, including enabling Chat and configuring the appearance. Read the tutorial ### Build apps for Chat A Zendesk app is a small web application installed in the agent interface that extends the functionality of Zendesk Support, Chat, or Sell. Visit Apps for information on how to get started and follow a step by step guide on building your first Chat app. Go to Apps Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status --- # Source: https://developer.zendesk.com/documentation/sales-crm/ Sell | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / Sales CRM Home - - ## Sales CRM - Introduction - Making your first call - - ### Sync API - Sync API FAQs - - ### Firehose - Firehose FAQs - Firehose Guarantees and Best Practices - Code samples ## On this page - Getting started - Core API - Sync API - Firehose API - Search API - Build apps for Sell # Sell Build your own Sell-powered applications ## On this page - Getting started - Core API - Sync API - Firehose API - Search API - Build apps for Sell ## Getting started Zendesk Sell simplifies your sales workflow and increases closure-rate and customer success. Sell's tools enable you to set up automated sequences to engage leads, see customer conversations in context, configure advanced user permissions, and more. In Getting started with Zendesk Sell you'll learn some of the most important features in your Sell account that you can explore in your free 14-day trial, or when you are getting started with Sell. Making your first call is a step-by-step guide on how to make your first request to the Sell API. We will provide your authentication details by returning a token using your login credentials. There are four groups of Zendesk Sell APIs : - Core API - Sync API - Firehose API - Search API ## Core API The Core APIs let you to create, read, update, and delete Sell data RESTfully. Core APIs are available on all Sell subscription plans . For more information, see Core API Introduction . ## Sync API The Sync API lets you connect to the Sell synchronization layer, in the same way our mobile devices do, which allows them to keep their local data up to date with Sell. The Sync APIs are available only on Sell Growth and higher plans. For more information, see: - Sync Introduction - Sync API reference ## Firehose API The Firehose API delivers a continuous stream of data from Sell in near real-time, enabling high volume data integrations and event-driven workflows within Sell or other business systems. The Firehose APIs are available only on Sell Growth and higher plans. For more information, see Firehose Introduction . ## Search API Search API provides access to Sell’s read layer. It exposes two ways for accessing data: - JSON search API with rich and powerful Query language - GraphQL API for querying company information alongside with Company Hierarchy data The Search APIs are available only on Sell Growth and higher plans. For more information, see: - Search Introduction - Search API Quick Start ## Build apps for Sell A Zendesk app is a small web application installed in the agent interface that extends the functionality of Zendesk Support, Chat, or Sell. For more information, see: - Apps - Building your first Sell app Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status --- # Source: https://developer.zendesk.com/documentation/ticketing/ Ticketing | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / Ticketing Home - - ## Ticketing - Introduction - - ### Getting Started - Ticketing API quick start - Using the Ticketing API - Common tasks for the Zendesk Ticketing API - - ### Managing Tickets - Creating and updating tickets - Creating and managing requests - Tickets vs Requests APIs: How to select the right option for your project - Adding ticket attachments with the API - Adding tags to tickets without overwriting existing tags - Adding voice comments to tickets - Getting the CSAT ratings of tickets - Getting the CSAT survey responses - Creating reports of daily ticket trends with the Zendesk API - Setting a skill priority for omnichannel routing - Building a custom ticket form with the Ticketing API - Improving performance by creating tickets asynchronously - Making client-side CORS requests to the Ticketing API - Making API requests on behalf of end users - Tutorial: Exporting a ticket view to a CSV file - Tutorial: Exporting a ticket to a CSV file - Closing stale tickets with the Tickets API - Reassigning orphaned tickets with the Tickets API - Creating side conversations with the Zendesk API - Creating a ticket dashboard with the Search API - - ### Custom Profiles - About the Profiles API - Getting started with profiles - Anatomy of a profile - How profiles affect existing data - Using identifier queries with profiles - Creating profiles - Accessing profiles - Accessing profiles in Zendesk apps - Updating profiles - Using external ID with profiles - - ### Custom Events - About the Events API - Getting started with events - Anatomy of an event - Displaying rich links with events - Tracking events - Accessing events - Accessing events in Zendesk apps - Filtering events - Deleting events - - ### Reference articles - Actions reference - Conditions reference - Conversation Log events reference - Ticket Audit events reference - Ticket metric event types reference - Cause of suspension reference - Via object reference - Via types reference - - ### API Clients - Introduction - Python - PHP - Node.js - .NET - Java - Ruby - Clojure - Elixir - Force.com - R ## On this page - Getting started - Creating tickets - Ticket Management - Working with OAuth - Embed and extend Support - Build Zendesk apps for Support - Add Support to your iOS and Android apps # Ticketing Create and manage tickets ## On this page - Getting started - Creating tickets - Ticket Management - Working with OAuth - Embed and extend Support - Build Zendesk apps for Support - Add Support to your iOS and Android apps ## Getting started In this 10-minute quickstart, you'll use the Zendesk API to create a few tickets. To keep things moving along, you'll use the JavaScript console of your browser to make the API requests. Zendesk API quick start ## Creating tickets Building a custom ticket form with the Ticketing API This article describes how to build a custom ticket form that lets users submit support requests from your website. Improving performance by creating tickets asynchronously If you create tickets in Zendesk Support with the API but want faster response times in your application, you can instruct the API to queue the jobs and just return a ticket ID and information about the status of the job. Adding tags to tickets without overwriting existing tags This article exmplains how to use the Update Many API. It lets you add tags without overwriting existing ones. You can also remove old tags without affecting existing tags. ## Ticket Management Common tasks for the Zendesk Support API This article covers common tasks performed with the Zendesk API, and lists the APIs and endpoints to use in your projects. Searching with the Zendesk API The Zendesk REST API provides the a single, unified API for searching Zendesk Support resources such as tickets, users, organizations, and groups. Side-loading Side-loading allows you to retrieve related records as part of a single request. Making cross-origin, browser-side API requests For security purposes, modern browsers have a same-origin policy restriction that prevents scripts from accessing resources in other domains. However, if the other domain implements Cross-Origin Resource Sharing (CORS), the browser will allow a script to access resources in that domain. Best practices for avoiding rate limiting When you reach the API rate limit, the Zendesk API stops processing any more requests until a certain amount of time has passed. This article covers the best practices for avoiding rate limiting. ## Working with OAuth OAuth authorization is to allow third-party applications to interact with a Zendesk Support instance without having to store and use the passwords of users, which is sensitive information that the apps shouldn't know. Using OAuth to authenticate Zendesk API requests in a web app In this tutorial, you'll build a web app that implements an OAuth authorization flow. Creating and using OAuth tokens with the API Using OAuth tokens for authentication doesn't tie the requests to a specific username and password, and it offers more control and security than plain API tokens. Set up a global OAuth client If you're developing an integration for Zendesk Support, you can use OAuth authentication to let users grant access to Zendesk Support to your integration. ## Embed and extend Support ### Build Zendesk apps for Support A Zendesk app is a small web application installed in the agent interface that extends the functionality of Zendesk Support, Chat, or Sell. Visit Apps for information on how to get started. Visit Apps ### Add Support to your iOS and Android apps The Support SDKs for iOS and Android lets you embed Zendesk Support options natively in your mobile app so your customers can get help directly in the app. Visit Mobile SDKs Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status --- # Source: https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/ Zendesk Web Widget and SDKs | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / Zendesk Web Widget and SDKs Home - - ## Zendesk Web Widget and SDKs - Introduction - Getting support on Zendesk mobile SDKs - Capabilities - Google Tag Manager support - Configuring private attachments for messaging - Authenticating users in your application - - ### SDKs - Web - Getting Started - Quick start - Creating a custom launcher - Quick start - Embedding a voice call button - Quick start - Opening the messaging Web Widget in a popup screen - Displaying the messaging Web Widget - Adding the messaging Web Widget to CTA buttons - Using Messaging Metadata with a Zendesk bot to send page data to a ticket - Web Widget embedded mode - Customizing Web Widget colors - Content Security Policy (CSP) support - Advanced Integration - Changelog - Android - Getting started - Setting up push notifications - Unread messages - Authenticating end users - Multi-conversations navigation APIs - Supported message types - Zendesk analytics tracking - Tracking with Zendesk events - Settting up delegates for links - Enabling proactive messaging - Setting up page view events - Implementing messaging metadata - Sending postback buttons - Customizing the UI - Help Center guidelines - Conversation extensions guidelines - Invalidating and switching SDK instances - Troubleshooting - Migrating from the Classic SDK to the Zendesk SDK - Migrating from Sunshine Conversations SDK to Zendesk - Migrating from Zendesk SDK version 1.x.x to 2.x.x - Localization - Release notes - Dependencies - Limitations and known issues - iOS - Getting started - Setting up push notifications - Unread messages - Authenticating end users - Multi-conversations navigation APIs - Supported message types - Zendesk analytics tracking - Tracking with Zendesk events - Setting up delegates for links - Enabling proactive messaging - Setting up page view events - Implementing messaging metadata - Sending postback buttons - Customizing the UI - Help Center guidelines - Invalidating and switching SDK instances - Swift async/await support - Troubleshooting - Migrating from Chat to Messaging SDK - Migrating from Sunshine Conversations SDK to Zendesk - Migrating from Zendesk SDK version 1.x.x to 2.x.x - Localization - Release notes - Limitations and known issues - Unity - Getting started - Managing fonts - Authenticating end users - Help Center - Messaging Metadata - Unread messages - Supported message types - Zendesk analytics tracking - Capabilities - Invalidating and switching SDK instances - Localizing the SDK - Limitations and known issues - Dependencies - Migration Guide - Troubleshooting - Release notes - Match 3 game ## On this page - Web - Android - iOS - Unity # Zendesk Web Widget and SDKs Provide customers with a rich, clean messaging experience ## On this page - Web - Android - iOS - Unity The Zendesk Web Widget and SDKs are a new conversational experience designed to provide customer support features such as messaging to your platforms. They are straightforward to implement, and are the best choice for most businesses who wish to provide their customers with a rich, clean messaging experience. For a more thorough introduction to messaging, check out our article "About messaging" . To get started, follow the instructions for your preferred platforms below. The Zendesk Web Widget and SDKs are relatively new, and as such, do not have all of the features and customization options of our previous Classic SDKs. Depending on your needs and the interactions that you'd like to provide to your customers, you may be interested in exploring them as well. You can check out our documentation to learn more about the Classic SDKs . ## Web Zendesk messaging for websites is supported by the Web Widget. To learn more, see Working with messaging in the Web Widget . The Web Widget API is a client-side JavaScript API for configuring the Web Widget settings and how it is displayed. This enables you to customize the Web Widget to your requirements on specific website pages. Web Widget API ## Android Add Messaging to your project to engage with your users from your Android app. Getting started ## iOS Add Messaging to your project to engage with your users from your iOS app. Getting started ## Unity Add Messaging to your project to engage with your users from your Unity game. Getting started Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status --- # Source: https://developer.zendesk.com/documentation/webhooks/ Webhooks | Zendesk Developer Docs zendev_horizontal zendev_horizontal Documentation API Reference Search / Webhooks Home - - ## Webhooks - Introduction - Creating and monitoring webhooks - Anatomy of a webhook request - Webhook security and authentication - Verifying webhooks from Zendesk ## On this page - Getting started with webhooks - Event schema # Webhooks Send HTTP requests based on activity in Zendesk ## On this page - Getting started with webhooks - Event schema Webhooks let you build or set up integrations that subscribe to certain activity in Zendesk Support, Guide, Gather, and Messaging. When this activity occurs, Zendesk sends a HTTP request to the webhook's configured URL. For example, you can configure a webhook to send requests when a user is deleted or a new ticket is created. ## Getting started with webhooks Creating and monitoring webhooks Use the Webhooks API to create a webhook and learn about the ways you connect a webhook to activity in Zendesk Support, Guide, Gather, and Messaging. The guide also covers webhook retry logic and how to monitor webhooks using the API. Anatomy of a webhook request Learn about the supported headers, methods, formats, and payloads for HTTP requests sent by webhooks. Webhook security and authentication Send authenticated requests from a webhook using API tokens. Verifying webhook authenticity HTTP requests from a Zendesk webhook include an encrpyted digital signature. Use this signature and a signing secret to verify that requests are genuine and come from Zendesk. ## Event schema Webhook event types If your webhook subscribes to events for user or organization activity, it sends HTTP POST requests with predefined JSON payloads. This reference documentation contains a list of available events and related request payloads. Join our developer community Forum Blog Slack Zendesk 181 Fremont Street, 17th Floor, San Francisco, California 94105 Privacy Notice Zendesk Developer Terms System Status