Zendesk is a customer service platform that helps businesses manage customer interactions across multiple channels. This component enables you to extract your Zendesk data into Keboola for analysis and reporting.
This component enables you to extract various types of data from your Zendesk instance, including tickets, users, organizations, and custom fields. It supports both full and incremental data loading.
- Extracts data from multiple Zendesk endpoints
- Supports incremental loading for most tables
- Handles authentication via API token
- Provides detailed logging and debugging options
- Supports extraction of ticket details (comments and audits)
- Zendesk account with API access
- API token
/api/v2/users.json/api/v2/groups.json/api/v2/group_memberships.json/api/v2/organizations.json/api/v2/tags.json/api/v2/ticket_fields.json/api/v2/incremental/tickets.json/api/v2/tickets/{ticket['id']}/comments.json/api/v2/tickets/{ticket['id']}/audits.json
Need more endpoints? Submit your request to ideas.keboola.com
{
"email": "your@email.com",
"#api_token": "your_api_token",
"sub_domain": "your_subdomain"
}- Full Sync: Downloads all data from the source every run
- Incremental Sync: Downloads data (tickets, ticket_comments, ticket_audits) based on the
start_timeparameter. The start time is taken from the last successful run.
- Full Load: Destination table is overwritten every run
- Incremental Load: Data is upserted into the destination table. Tables with primary keys will have rows updated, tables without primary keys will have rows appended.
- Comments
- Audits
Note: Loading details has an impact on performance as they are loaded per ticket.
Enable detailed logging for troubleshooting purposes.
- API rate limits apply (see Zendesk API documentation)
- Clone the repository:
git clone git@github.com:keboola/component-zendesk.git keboola.ex-zendesk-v2
cd keboola.ex-zendesk-v2- Configure local data folder in
docker-compose.yml:
volumes:
- ./:/code
- ./CUSTOM_FOLDER:/data- Build and run:
docker-compose build
docker-compose run --rm devRun the test suite and lint check:
docker-compose run --rm testFor deployment and integration with KBC, refer to the deployment documentation.