Zendesk

Connect your Zendesk data to Airweave

Overview

The Zendesk connector allows you to sync data from Zendesk into Airweave, making it available for search and retrieval by your agents.

Zendesk source implementation (read-only).

Retrieves data from Zendesk for the following objects:

Yields them as the corresponding entity objects defined in airweave.platform.entities.zendesk.

Explore the Zendesk connector implementation

This connector uses OAuth 2.0 with refresh token.

You can connect through the Airweave UI, which will guide you through the OAuth flow.

The following data models are available for this connector:

Schema for a Zendesk organization.

Field	Type	Description
name	Optional[str]	Name of the organization.
details	Optional[str]	Details about the organization.
domain_names	List[str]	List of domain names associated with this organization.
external_id	Optional[str]	An external ID for this organization.
shared_tickets	bool	Whether tickets from this organization are shareable with all members.
shared_comments	bool	Whether comments are shared between all members of the organization.
created_at	Optional[datetime]	When the organization was created.
updated_at	Optional[datetime]	When the organization was last updated.
archived	bool	Placeholder for archival state if applicable.

Schema for a Zendesk user (agent or end user).

Field	Type	Description
name	Optional[str]	The user’s full name.
email	Optional[str]	The user’s email address.
role	Optional[str]	Role assigned, e.g., ‘admin’, ‘agent’, ‘end-user’.
time_zone	Optional[str]	The user’s time zone.
locale	Optional[str]	Locale for the user (language, date/time format).
active	bool	Whether the user is currently active.
verified	bool	Whether the user’s identity is verified.
shared	bool	Whether the user is shared from a different Zendesk instance or created locally.
suspended	bool	Whether the user is suspended.
last_login_at	Optional[datetime]	When the user last signed in (if available).
created_at	Optional[datetime]	When the user was created.
updated_at	Optional[datetime]	When the user was last updated.
archived	bool	Placeholder for archival state if applicable.

Schema for a Zendesk ticket.

Field	Type	Description
subject	Optional[str]	Subject or summary of the ticket.
description	Optional[str]	Description text of the ticket.
type	Optional[str]	Type of ticket, e.g., ‘question’, ‘incident’.
priority	Optional[str]	Priority of the ticket, e.g., ‘low’, ‘normal’.
status	Optional[str]	Current status, e.g., ‘open’, ‘pending’.
tags	List[str]	List of tags attached to the ticket.
requester_id	Optional[str]	ID of the user that requested the ticket (i.e., the ticket’s author).
assignee_id	Optional[str]	ID of the user (agent) assigned to handle this ticket.
organization_id	Optional[str]	ID of the organization associated with this ticket.
group_id	Optional[str]	ID of the group this ticket is assigned to.
created_at	Optional[datetime]	When the ticket was created.
updated_at	Optional[datetime]	When the ticket was last updated.
due_at	Optional[datetime]	When this ticket is due.
via	Optional[Dict[str, Any]]	Details about the source through which this ticket was created (e.g., channel).
custom_fields	List[Dict[str, Any]]	List of custom field objects with id/value pairs for this ticket.
archived	bool	Placeholder for archival state if applicable.

Schema for a Zendesk comment, typically tied to a specific ticket.

Field	Type	Description
ticket_id	str	ID of the ticket this comment belongs to.
author_id	Optional[str]	ID of the user who wrote this comment.
plain_body	Optional[str]	Plain text version of the comment.
public	bool	Whether the comment is public or private.
created_at	Optional[datetime]	When the comment was created.
attachments	List[Dict[str, Any]]	Attachments associated with the comment, if any.
archived	bool	Placeholder for archival state if applicable.