Zendesk Exporter

This project is a tool for exporting data from Zendesk, including tickets, comments, users, views, triggers, macros, automations, settings, and support addresses.

You can use it for backup, migration, or analysis. Data is exported to JSON files, but most of the files you have to read line by line to extract JSON data.

Getting Started

Prerequisites

Before running the project, ensure you have the following prerequisites installed:

• Node.js
• npm (Node Package Manager)

Installation

1. Clone the repository:

   git clone https://github.com/TheGP/Zendesk-Exporter.git

2. Navigate to the project directory:

   cd zendesk-exporter

3. Install dependencies:

   npm install

Usage

To export data from Zendesk, follow these steps:

1. Set up your Zendesk API credentials by creating a .env file in the root directory of the project and adding your Zendesk email and token:

   ZENDESK_API=https://yourdomain.zendesk.com/api/v2/
   [email protected]
   ZENDESK_TOKEN=your-zendesk-token
   

2. Run the export script:

   npm start

This will start the export process, fetching data from Zendesk API and saving it into JSON files in the exported directory.

To modify export look for exportAll function, you may disable / enable items you need to export.

Contributing

Contributions are welcome! Please follow these steps to contribute to the project:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Make changes and commit them (git commit -am 'Add your feature').
4. Push to the branch (git push origin feature/your-feature).
5. Create a new pull request.

License

This project is licensed under the MIT License