Skip to main content
@frogbotai/piece-zendesk works with Zendesk Support and Help Center through their REST APIs. Imports export tickets, users, organizations, ticket events and articles, and list comments, groups, fields, help-center categories and sections, macros, views and SLA policies; agents create and update tickets, comments, users and organizations; triggers react to new and changed tickets, comments, users and organizations.

Connect Zendesk

secret: true lets each person paste their own subdomain, email and token when connecting. A person who hasn’t connected gets a missing error asking them to link Zendesk. The factory auth on this instance is unused for their calls; see When the code credential is used. Every request goes to https://<subdomain>.zendesk.com with Authorization: Basic base64(<email>/token:<apiToken>), and nowhere else. See factory options for the shared options.

Make an API token

Exports and webhooks need an admin, so make the token as one, ideally a dedicated admin account:
  1. In Admin Center, open Apps and integrations → APIs → API tokens (on older accounts, Zendesk API), and turn on Token access.
  2. Choose Add API token, describe it, and copy it. Zendesk shows it only once.
  3. Use it as auth.apiToken, with that admin’s email as auth.email.
Sign-in with Zendesk isn’t offered: a Zendesk OAuth client works for one account only.

Export an account

Exports page through everything that changed since a time, oldest first, for imports and later syncs: Each takes startTime on the first call, or cursor to continue, never both. startTime is an ISO time, such as 1970-01-01T00:00:00Z for everything. Each returns { data, pagination: { count, hasMore, nextCursor } }. Call again with nextCursor until hasMore is false. Then keep the last nextCursor and pass it next time to get only what changed since.
  • Zendesk allows 10 export requests a minute (20 for exportUsers) per account. A big first import takes a while: about 1,000 tickets a request, so 100,000 tickets is about 10 minutes of requests.
  • Exports never include the last minute: startTime must be at least a minute ago, and the newest changes appear on a later call.
  • When Zendesk rate-limits a request, FrogBot waits for its Retry-After and retries up to 3 times, stopping early if the request is aborted. Errors keep Zendesk’s message and status.

Lists

Lists take limit (1–100, default 100) and cursor, and return { data, pagination: { count, hasMore, nextCursor, limit } }. listSlaPolicies returns every policy at once. downloadAttachment follows Zendesk’s redirect to its file storage without the API token. The token goes only to the account’s own address.

Actions

Inputs that name a Zendesk record take its numeric id. Custom fields take the ids or keys from the field lists.

Triggers

Each webhook event carries { id, type, time, detail, event }: detail is the ticket, user or organization as it is now, and event is what changed. Zendesk sends ids in detail as strings. Upsert by id so a repeated event is harmless.

Webhooks

Each mounted webhook trigger creates its own Zendesk webhook, subscribed to Zendesk’s built-in events, so nothing has to be set up in Zendesk, and deletes it when unmounted. The app needs a public serverURL (see Triggers). Every delivery is signed with that webhook’s secret, and an unsigned or wrongly signed one is refused.
  • One Zendesk webhook per mounted trigger: trial accounts allow only 10 webhooks.
  • If Zendesk turns off a webhook after failed deliveries, FrogBot isn’t told and the subscription still looks active. Re-export with the last cursors to catch up.
Triggers run with no signed-in person, so mount them on a separate instance with its own auth and no connection entry. The instance in your connection entry throws missing without a signed-in person:

Polling

The polling triggers run every 5 minutes by default (see polling). The first poll only records what already exists, and emits nothing.