Zendesk Sell API Essential Guide

What type of API does Zendesk Sell provide?

Zendesk Sell primarily uses a REST API, but also offers GraphQL capabilities for certain functionalities.

REST API

Zendesk Sell's main API is RESTful, consisting of several components:

1. Core API:

   • Allows you to create, read, update, and delete Sell data RESTfully.
   • Available on all Sell subscription plans.

2. Sync API:

   • Enables programmatic syncing of latest Sell data.
   • Available on Sell Growth and higher plans.

3. Firehose API:

   • Provides a near real-time stream of changes in Sell data.
   • Includes resource deltas, current snapshots, and user information.
   • Available on Sell Growth and higher plans.

4. Search API:

   • Allows querying data entities in Sell with custom complex filters, sorting, and aggregations.
   • Available on Sell Growth and higher plans.

GraphQL API

Zendesk Sell also offers GraphQL capabilities, but with limited scope:

1. It's part of the Search API and is currently available only for querying company information.
2. Allows exploration of company hierarchies.
3. Provides a convenient way to query company attributes and relationships within the company hierarchy.

Does the Zendesk Sell API have webhooks?

Webhooks Availability

The search results do not provide any specific information about webhooks for Zendesk Sell API. The information provided is mostly about webhooks in Zendesk Support and other Zendesk products, but not specifically for Zendesk Sell.

Event Types

While there is no direct mention of Zendesk Sell webhook events, the search results do provide information about webhook event types for other Zendesk products:

• Article events
• Community post events
• Organization events
• User events
• Agent availability events
• Omnichannel routing configuration events

However, it's important to note that these event types are not specifically for Zendesk Sell.

Key Considerations

1. The search results primarily focus on webhooks for Zendesk Support and other Zendesk products, not Zendesk Sell specifically.

2. Zendesk does offer webhook functionality for some of its products, allowing integration with third-party systems.

3. For Zendesk Support, webhooks can be subscribed to specific events or connected to triggers and automations.

4. The webhook payloads for Zendesk events use a standardized JSON schema.

Conclusion

Based on the provided search results, there is no clear information about webhooks specifically for the Zendesk Sell API. The information available is mostly about webhooks in other Zendesk products. To get accurate information about webhooks in Zendesk Sell, you would need to consult the official Zendesk Sell API documentation or contact Zendesk support directly.

Rate Limits and other limitations

The API rate limits for the Zendesk Sell API are as follows:

General Rate Limit

• Up to 36,000 requests per hour (10 requests/token/second) [1]

This limit is applied on a per-token basis. If you consistently hit this limit, Zendesk recommends contacting them.

Plan-Specific Rate Limits

The rate limits also vary based on your Zendesk plan:

• Essential (legacy): 10 requests per minute
• Team: 200 requests per minute
• Professional: 400 requests per minute
• Enterprise: 700 requests per minute
• High Volume API add-on: 2500 requests per minute

Additional Limits

• Zendesk apps have an additional limit of 100 requests per minute per user per app
• Some specific endpoints have their own rate limits, for example:
  • Update Ticket: 30 updates per 10 minutes per user per ticket
  • Incremental Exports: 10 requests per minute (30 with High Volume add-on)
  • Update User: 5 requests per minute per user

Key Points to Consider

• The Help Center API has separate rate limits from the Support API
• There's an overall account-wide limit of 100,000 requests per minute
• You can monitor your API usage in the Zendesk Admin Center
• The API returns rate limit information in response headers, which you can use to track usage

Increasing Rate Limits

If you need higher limits, you have two main options:

1. Upgrade to a higher pricing plan
2. Purchase the High Volume API add-on (available for Suite Growth plan and above), which increases the limit to 2500 requests per minute

Best Practices

To avoid hitting rate limits:

1. Monitor your API usage using the provided dashboard and response headers
2. Implement proper error handling for 429 (Too Many Requests) responses
3. Use bulk endpoints where possible to reduce the number of API calls
4. Regulate your request rate to stay within limits

Remember to always check the most current documentation, as rate limits may change over time.

Latest API Version

Based on the search results provided, there is no specific mention of the most recent version of the Zendesk Sell API. However, I can provide some key information about the Zendesk Sell API:

Key Points

1. Zendesk Sell offers multiple types of APIs to suit various integration needs:

   • Core API: Allows you to create, read, update, and delete Sell data RESTfully.
   • Sync API: Enables you to keep your local data up to date with Sell.
   • Firehose API: Delivers a continuous stream of data from Sell in near real-time.
   • Search API: Provides access to Sell's read layer with JSON search and GraphQL capabilities.

2. The API endpoint for Zendesk Sell is https://api.getbase.com.

3. API access is available on Sell Growth plans and higher.

Best Practices

1. When working with the Zendesk Sell API, it's recommended to:

   • Familiarize yourself with the common formats of API requests, responses, and errors.
   • Get acquainted with the Sell API authentication, which is powered by industry-standard OAuth 2.0.
   • Check the pricing and rate limits for the Sell API.

2. If you're using or planning to use Deal decimal values in Sell, be aware that there may be compatibility issues with the new API format.

3. For developers looking to build integrations, Zendesk provides:

   • Pre-built code libraries and solutions.
   • An in-house team of integration experts for custom solutions.
   • Ongoing support for custom integrations built by the Sell team.

While the search results don't provide information about the most recent version of the Zendesk Sell API, it's always best to refer to the official Zendesk developer documentation for the most up-to-date information on API versions and changes. You can find this information on the Zendesk Developer Portal.

How to get a Zendesk Sell developer account and API Keys?

To get a developer account for Zendesk Sell to create an API integration, you can follow these steps:

Get a trial account

1. Sign up for a free 14-day trial of Zendesk Sell at https://www.zendesk.com/register/?source=zendesk_sell#step-1.

2. When setting up the account, add the prefix "d3v-" to your chosen subdomain name. For example: d3v-yourcompany.zendesk.com.

Key points to consider

• The free trial lasts for 14 days.
• You'll have access to most Sell features during the trial period.
• After the trial, you'll need to choose a paid plan to continue using Sell and its APIs.

For Marketplace developers

If you're interested in becoming a Zendesk developer partner and creating apps for the Zendesk Marketplace:

1. You can request to convert your trial account into a sponsored Zendesk Sell account.
2. Sponsored accounts do not expire after 14 days.
3. Sponsored Sell accounts include all features on the Sell Elite plan, except for the Firehose, Sync, and Search APIs.

API access

Once you have an account:

1. You can start exploring the Sell API documentation at https://developer.zendesk.com/api-reference/sales-crm/introduction/.
2. Familiarize yourself with the authentication process, which uses OAuth 2.0.
3. Make your first API call following the guide provided in the documentation.

Best practices

• Always use the "d3v-" prefix for development accounts to clearly distinguish them from production accounts.
• If you already have a trial account without the prefix, you can rename your subdomain to add it.
• For serious development work, consider becoming a Zendesk developer partner to get a sponsored account with extended access.

Remember that API access and features may vary depending on your Sell subscription plan. Make sure to review the pricing and rate limits for the Sell API before starting your integration work.

What can you do with the Zendesk Sell API?

Based on the search results provided, here is a list of data models you can interact with using the Zendesk Sell API, along with what is possible for each:

Leads

• Create new leads
• Update existing leads
• Retrieve lead information
• Associate leads with other objects like contacts or deals

Contacts

• Create and manage contact records
• Update contact information
• Link contacts to leads or deals

Deals

• Create and update deal records
• Associate deals with leads or contacts
• Track deal progress and stages

Custom Objects

• Create custom object types specific to your business
• Define properties and relationships for custom objects
• Link custom objects to standard objects like leads, contacts, or deals
• Create, read, update, and delete custom object records
• Search and filter custom object records

Users

• Manage user accounts and permissions
• Retrieve user information

Organizations

• Create and manage organization records
• Associate organizations with contacts or deals

Activities

• Create and track sales activities (calls, emails, tasks, etc.)
• Associate activities with leads, contacts, or deals

Products

• Manage product catalogs
• Associate products with deals

Notes

• Add notes to leads, contacts, deals, or other objects
• Retrieve and update note information

Tags

• Add and remove tags from various objects
• Search and filter objects by tags

Pipelines and Stages

• Retrieve pipeline and stage information
• Move deals between stages

Sources

• Manage lead and deal sources
• Associate sources with leads or deals

Custom Fields

• Create and manage custom fields for various objects
• Update and retrieve custom field values

Attachments

• Upload and manage attachments for various objects
• Retrieve attachment information

Key points to consider:

1. The Zendesk Sell API allows for CRUD (Create, Read, Update, Delete) operations on most of these data models.
2. Custom objects provide flexibility to model and store data specific to your business needs.
3. The API supports searching and filtering capabilities for efficient data retrieval.
4. Some advanced features like the Firehose API and Search API are only available on higher-tier Sell plans.
5. Rate limits should be considered when making API requests to ensure compliance with Zendesk Sell's policies.

Remember to refer to the official Zendesk Sell API documentation for the most up-to-date and detailed information on interacting with these data models.