Zendesk

Creating the data source

Requirements

  • Follow the steps using an Owner/Administrator account
  • If your Zendesk account has IP blocking enabled, also allow Kondado’s IPs

Instructions

  1. Log in to your Zendesk account with an Owner/Administrator account
  2. Once inside, select the gear icon (settings) on the left sidebar, then go to Channels > API
  3. In APIs, enable token access and then click on Add New
  4. On the new token edit page, give it a name (for example, Kondado integration), copy the generated value, and click Save
  5. In the Kondado platform, click CREATE+ > Connector > and select the Zendesk connector
  6. Fill in the information as follows
    1. Name: The name of your integration, for example, “Zendesk”
    2. Email (Owner): The email of the Zendesk account Owner
    3. Token: The token generated in step 4
    4. Subdomain: Your Zendesk subdomain. For example, if your Zendesk URL is company.zendesk.com, then your subdomain is company

If your Zendesk account has IP blocking enabled, also allow Kondado’s IPs

Pipelines

Summary

Relationship chart

Click to expand

Brands

Replication type: Full

Main object

Campo Tipo

id

text

[en] The unique identifier of the brand in Zendesk.

active

boolean

[en] Specifies whether the brand is currently active in Zendesk.

brand_url

text

[en] The public URL for the brand, typically used by customers to access the help center or support site.

default

boolean

[en] Indicates if this brand is set as the default brand for the Zendesk account.

has_help_center

boolean

[en] Indicates whether the brand has an active Help Center enabled.

help_center_state

text

[en] The current state of the brand's Help Center (e.g., enabled, disabled).

host_mapping

text

[en] The custom host mapping (CNAME) used to map the brand’s support site to a custom domain.

is_deleted

boolean

[en] Specifies whether the brand has been deleted from Zendesk.

logo_content_type

text

[en] The MIME type of the logo file (e.g., image/png).

logo_content_url

text

[en] The direct URL where the logo image can be accessed.

logo_deleted

boolean

[en] Specifies whether the logo file has been deleted.

logo_file_name

text

[en] The file name of the logo image.

logo_height

float

[en] The height of the logo image in pixels.

logo_id

text

[en] The unique identifier of the logo attachment.

logo_inline

boolean

[en] Indicates whether the logo is intended for inline display.

logo_mapped_content_url

text

[en] The mapped URL of the logo image, typically the same as content_url.

logo_size

float

[en] The file size of the logo image in bytes.

logo_url

text

[en] The API endpoint URL for retrieving the brand's logo attachment details.

logo_width

float

[en] The width of the logo image in pixels.

name

text

[en] The name of the brand (e.g., Torra).

subdomain

text

[en] The Zendesk subdomain associated with the brand.

url

text

[en] The API endpoint URL for retrieving the brand details in Zendesk.

ticket_form_ids

text

signature_template

text

created_at

timestamp

updated_at

timestamp

zendesk_brands_logo_thumbnails

Campo Tipo

brand_id

text

[en] The unique identifier of the brand in Zendesk.

logo_thumbnails_id

text

[en] The unique identifier of the logo thumbnail attachment.

logo_thumbnails_content_type

text

[en] The MIME type of the thumbnail file (e.g., image/png).

logo_thumbnails_content_url

text

[en] The direct URL where the thumbnail image can be accessed.

logo_thumbnails_deleted

boolean

[en] Specifies whether the thumbnail file has been deleted.

logo_thumbnails_file_name

text

[en] The file name of the thumbnail image.

logo_thumbnails_height

float

[en] The height of the thumbnail image in pixels.

logo_thumbnails_inline

boolean

[en] Indicates whether the thumbnail is intended for inline display.

logo_thumbnails_mapped_content_url

text

[en] The mapped URL of the thumbnail image, typically the same as content_url.

logo_thumbnails_size

float

[en] The file size of the thumbnail image in bytes.

logo_thumbnails_url

text

[en] The API endpoint URL for retrieving a thumbnail version of the logo.

logo_thumbnails_width

float

[en] The width of the thumbnail image in pixels.

Closed and Deleted Tickets

Replication type: Incremental

Deleted Zendesk tickets with actor, status, and timestamps.

Campo Tipo

id

text

[en] Unique identifier of the ticket.

actor_id

text

[en] Identifier of the actor (agente ou usuário) que realizou a exclusão.

actor_name

text

[en] Display name of the actor who deleted the ticket.

deleted_at

timestamp

[en] Date and time when the ticket was deleted.

description

text

[en] Main description/content of the deleted ticket.

previous_state

text

[en] Status of the ticket before deletion (ex.: solved, closed).

subject

text

[en] Subject/title of the deleted ticket.

Groups

Replication type: Full

Zendesk groups with membership and status information.

Campo Tipo

id

text

[en] Unique identifier of the group.

updated_at

timestamp

[en] When the group was last updated.

default

boolean

[en] Indicates whether this is the account’s default group.

name

text

[en] Group name.

url

text

[en] URL for the group record.

created_at

timestamp

[en] When the group was created.

deleted

boolean

[en] Flags whether the group is marked as deleted.

description

text

[en] Text description of the group.

Jira links

Replication type: Full

Links between Zendesk tickets and Jira issues.

Campo Tipo

id

text

[en] Identifier of the link record.

ticket_id

text

[en] ID of the related Zendesk ticket.

    Tickets > > id

issue_id

text

[en] ID da issue correspondente no Jira.

issue_key

text

[en] Key of the linked Jira issue.

url

text

[en] URL for the link record.

created_at

timestamp

[en] When the link was created.

updated_at

timestamp

[en] When the link was last updated.

Organizations

Replication type: Full

Zendesk organizations with domains, sharing settings, custom fields and timestamps.

Campo Tipo

id

text

[en] Unique identifier of the organization.

shared_comments

boolean

[en] Allows end users in the organization to see each other’s ticket comments.

updated_at

timestamp

[en] When the organization was last updated.

domain_names

text

[en] Email domains linked to the organization.

shared_tickets

boolean

[en] Allows end users in the organization to view each other’s tickets.

name

text

[en] Unique name of the organization.

url

text

[en] URL for the organization record.

organization_fields

text

[en] Custom fields stored for the organization.

created_at

timestamp

[en] When the organization was created.

tags

text

[en] Tags associated with the organization.

details

text

[en] Additional details about the organization (e.g., address).

group_id

text

[en] Group automatically assigned to new tickets from this organization.

external_id

text

[en] External ID to link the organization to another system (case-insensitive).

notes

text

[en] Internal notes about the organization.

Satisfaction ratings

Replication type: Incremental

Satisfaction ratings for tickets, with requester, assignee and timestamps.

Campo Tipo

id

text

[en] Unique identifier of the satisfaction rating.

comment

text

[en] Comment submitted with the rating, when available.

assignee_id

text

[en] Agent assigned at the time of the rating.

score

text

[en] Rating value (offered, unoffered, good, bad).

ticket_id

text

[en] Identifier of the rated ticket.

    Tickets > > id

requester_id

text

[en] Requester who submitted the rating.

url

text

[en] URL for the rating record.

created_at

timestamp

[en] When the satisfaction rating was created.

group_id

text

[en] Group assigned to the ticket when rated.

updated_at

timestamp

[en] When the satisfaction rating was last updated.

Ticket Metric Events

Replication type: Incremental

Event history for ticket SLA metrics (apply, pause, breach, status updates).

Campo Tipo

id

text

[en] Unique identifier of the metric event.

deleted

boolean

[en] Available for breach events; ignore when true.

group_sla_business_hours

boolean

[en] Indicates if group SLA timing uses business hours.

group_sla_policy_description

text

[en] Description of the group SLA policy applied.

group_sla_policy_title

text

[en] Title of the group SLA policy applied.

group_sla_policy_id

text

[en] For apply_group_sla events: ID of the enforced group SLA policy.

group_sla_target

float

[en] Group SLA target being enforced (apply_group_sla events).

instance_id

text

[en] Instance number of the metric event (increments per ticket).

metric

text

[en] Metric tracked (ex.: agent_work_time, reply_time, requester_wait_time).

sla_business_hours

boolean

sla_policy_description

text

[en] Description of the SLA policy applied.

sla_policy_title

text

[en] Title of the SLA policy applied.

sla_policy_id

text

[en] Available for apply_sla events: ID of the SLA policy enforced.

sla_target

float

[en] SLA target being enforced (apply_sla events).

status_business

float

[en] For update_status events: minutes open in business hours.

status_calendar

float

[en] For update_status events: minutes open in calendar hours.

ticket_id

text

[en] Identifier of the associated ticket.

    Tickets > > id

time

timestamp

[en] Timestamp when the event occurred.

type

text

[en] Type of metric event (activate, pause, fulfill, apply_sla, breach, update_status, measure).

Ticket audits

Replication type: Incremental

Main object

Audits of ticket changes with channel metadata and author details.

Campo Tipo

id

text

[en] Unique identifier of the audit event.

ticket_id

text

[en] Identifier of the ticket associated with the audit.

    Tickets > > id

via__source__to__name

text

[en] Destination name captured in the channel metadata.

via__source__to__address

text

[en] Destination address captured in the channel metadata.

via__source__from__original_recipients

text

[en] Original recipients listed in the channel metadata.

via__source__from__name

text

[en] Source name captured in the channel metadata.

via__source__from__address

text

[en] Source address captured in the channel metadata.

via__source__rel

text

[en] Relationship indicator in the source metadata.

via__channel

text

[en] Channel through which the audit action happened.

created_at

timestamp

[en] When the audit event was created.

author_id

text

[en] User who generated the audit event.

metadata__system__latitude

float

[en] Latitude recorded in system metadata, when available.

metadata__system__client

text

[en] Client user agent recorded in system metadata.

metadata__system__ip_address

text

[en] IP address recorded in system metadata.

metadata__system__location

text

[en] Location string derived from system metadata.

metadata__system__longitude

float

[en] Longitude recorded in system metadata, when available.

zendesk_ticket_audits__events

Events that compose each ticket audit, including type and payload.

Campo Tipo

audit_id

text

[en] Identifier of the parent audit.

events__data

text

[en] Raw data payload for the audit event.

events__type

text

[en] Type of the audit event.

events_id

text

[en] Identifier of the event within the audit.

Ticket comments

Replication type: Incremental

Comments on tickets with author and creation details.

Campo Tipo

ticket_id

text

[en] Identifier of the ticket the comment belongs to.

    Tickets > > id

id

text

[en] Identifier of the comment.

author_id

text

[en] Identifier of the user who authored the comment.

    Users > > id

created_at

timestamp

[en] When the comment was created.

public

boolean

[en] Indicates whether the comment is public.

body

text

[en] Body of the comment in text form.

Ticket metrics

Replication type: Incremental

Zendesk Chat ticket metrics with waits, replies, and reopens.

Campo Tipo

ticket_id

text

[en] Identifier of the associated ticket.

    Tickets > > id

id

text

[en] Identifier of the ticket metric record.

updated_at

timestamp

[en] When the metric record was last updated.

solved_at

timestamp

[en] When the ticket was solved.

replies

int

[en] Number of public replies added by agents.

full_resolution_time_in_minutes__calendar

float

[en] Minutes to full resolution (calendar hours).

full_resolution_time_in_minutes__business

float

[en] Minutes to full resolution (business hours).

on_hold_time_in_minutes__calendar

float

[en] Minutes on hold during calendar hours.

on_hold_time_in_minutes__business

float

[en] Minutes on hold during business hours.

status_updated_at

timestamp

[en] When the ticket status was last updated.

assignee_stations

float

[en] Number of different assignees the ticket had.

requester_updated_at

timestamp

[en] When the requester last updated the ticket.

initially_assigned_at

timestamp

[en] When the ticket was first assigned.

group_stations

float

[en] Number of groups the ticket passed through.

first_resolution_time_in_minutes__calendar

float

[en] Minutes to first resolution (calendar hours).

first_resolution_time_in_minutes__business

float

[en] Minutes to first resolution (business hours).

assigned_at

timestamp

[en] When the ticket was assigned.

latest_comment_added_at

timestamp

[en] When the latest comment was added.

reply_time_in_minutes__calendar

float

[en] Minutes to first reply (calendar hours).

reply_time_in_minutes__business

float

[en] Minutes to first reply (business hours).

url

text

[en] URL for the ticket metric record.

created_at

timestamp

[en] When the metric record was created.

assignee_updated_at

timestamp

[en] When the assignee last updated the ticket.

reopens

float

[en] Number of times the ticket was reopened.

requester_wait_time_in_minutes__calendar

float

[en] Minutes the requester waited (calendar hours).

requester_wait_time_in_minutes__business

float

[en] Minutes the requester waited (business hours).

agent_wait_time_in_minutes__calendar

float

[en] Minutes the agent waited (calendar hours).

agent_wait_time_in_minutes__business

float

[en] Minutes the agent waited (business hours).

Tickets

Replication type: Incremental

Main object

Zendesk tickets with request details, routing, and linkage metadata.

Campo Tipo

id

text

[en] Unique identifier of the ticket.

status

text

[en] Status of the ticket (new, open, pending, hold, solved, closed).

follower_ids

text

[en] Identifiers of agents following the ticket.

via__source__to__name

text

[en] Destination name in the ticket source metadata.

via__source__to__address

text

[en] Destination address in the ticket source metadata.

via__source__from__name

text

[en] Source name captured for the ticket.

via__source__from__address

text

[en] Source address captured for the ticket.

via__source__rel

text

[en] Relationship indicator in the ticket source metadata.

via__channel

text

[en] Channel through which the ticket was created.

description

text

[en] First comment/body of the ticket (somente leitura).

tags

text

[en] Tags aplicadas ao ticket.

problem_id

text

[en] For incident tickets, ID of the related problem ticket.

allow_channelback

boolean

[en] Indicates if channelback is allowed for this ticket.

updated_at

timestamp

[en] When the ticket record was last updated.

submitter_id

text

[en] User who submitted the ticket (autor do primeiro comentário).

    Users > > id

assignee_id

text

[en] Agent currently assigned to the ticket.

    Users > > id

brand_id

text

[en] Identifier of the brand linked to this ticket.

due_at

timestamp

[en] Due date/time for task-type tickets.

satisfaction_rating

text

[en] Satisfaction rating or state (offered/unoffered) when available.

is_public

boolean

[en] True when the ticket has public comments.

requester_id

text

[en] User who requested the ticket.

    Users > > id

forum_topic_id

text

[en] Forum topic the ticket came from (when applicable).

recipient

text

[en] Original recipient address used for notifications.

subject

text

[en] Ticket subject text.

organization_id

text

[en] Organization linked to the requester.

    Organizations > > id

url

text

[en] URL for the ticket record.

type

text

[en] Ticket type (problem, incident, question, task).

created_at

timestamp

[en] When the ticket record was created.

sharing_agreement_ids

text

[en] Identifiers of sharing agreements applied to the ticket.

allow_attachments

boolean

[en] Indicates if agents can add attachments to comments.

followup_ids

text

[en] IDs de follow-ups criados a partir deste ticket (visíveis após o fechamento).

collaborator_ids

text

[en] Identifiers of users currently em cópia no ticket.

priority

text

[en] Priority level (urgent, high, normal, low).

raw_subject

text

[en] Dynamic content placeholder for the subject, or the subject text itself.

email_cc_ids

text

[en] IDs de agentes ou usuários finais atualmente em cópia no ticket.

has_incidents

boolean

[en] Indicates if a problem-type ticket has linked incidents.

group_id

text

[en] Group assigned to the ticket.

    Groups > > id

external_id

text

[en] External identifier to link the ticket to another system.

zendesk_tickets__fields

Custom field values expanded per ticket.

Campo Tipo

ticket_id

text

[en] ID of the parent ticket.

fields__id

text

[en] Identifier of the ticket field.

fields_title

text

[en] Title/label of the field.

fields__value

text

[en] Value stored in the custom field.

Users

Replication type: Incremental

Zendesk users with profile, role, and access details.

Campo Tipo

id

text

[en] Unique identifier of the user.

tags

text

[en] Tags assigned to the user when tagging is enabled.

locale

text

[en] Language/region configured for the user.

shared_agent

boolean

[en] Indicates if the agent is shared from another Zendesk instance (ticket sharing).

updated_at

timestamp

[en] When the user record was last updated.

restricted_agent

boolean

[en] Flags whether the agent has restrictions (false for admins/unrestricted agents).

organization_id

text

[en] Identifier of the user’s organization.

phone

text

[en] Primary phone number of the user.

custom_role_id

text

[en] Custom role ID for agents on Enterprise plans or above.

last_login_at

timestamp

[en] Date/time of the last sign-in or authenticated access.

role_type

text

[en] Numeric role type (0 custom agent, 1 light agent, 2 chat agent, 3 chat contributor, 4 admin, 5 billing admin).

default_group_id

text

[en] Identifier of the user’s default group.

suspended

boolean

[en] Indicates whether the user is suspended; suspended users cannot sign in.

report_csv

boolean

[en] Allows access to CSV reports in reporting (plans with this feature only).

active

boolean

[en] Indicates whether the user is active (not deleted).

two_factor_auth_enabled

boolean

[en] Indicates if two-factor authentication is enabled.

notes

text

[en] Internal notes stored about the user.

iana_time_zone

text

[en] IANA time zone set for the user.

moderator

boolean

[en] Indicates if the user can moderate forums.

verified

boolean

[en] Flags if any identity for the user is verified.

name

text

[en] Full name of the user.

only_private_comments

boolean

[en] If true, the user can create only private comments.

url

text

[en] URL for the user record.

created_at

timestamp

[en] When the user record was created.

time_zone

text

[en] Time zone string set for the user.

shared_phone_number

text

[en] Indicates whether the phone number is shared.

alias

text

[en] Alternate name shown to end users.

role

text

[en] Role label for the user (end-user, agent, admin).

details

text

[en] Additional details stored about the user (ex.: endereço).

signature

text

[en] Signature configured for the user (agents/admins only).

shared

boolean

[en] Indicates if the user is shared from another instance (ticket sharing).

external_id

text

[en] External identifier from another system (case sensitive).

email

text

[en] Primary email address of the user.

chat_only

boolean

[en] Flags if the user is a chat-only agent.

ticket_restriction

text

[en] Access scope for tickets (organization, groups, assigned, requested, or null).

Notes

  • Part of this documentation was automatically generated by AI and may contain errors. We recommend verifying critical information