Configuration

Environment Variables

ZENDESK_API_KEY=<YourZenDeskApiKey>
ZENDESK_EMAIL=<YourZenDeskSupportEmail>
ZENDESK_API_URL=<YourZenDeskApiUrl>
ZENDESK_API_VERSION=<YourZenDeskApiVersion>
ZENDESK_SUBJECT_OPTIONS=<YourZenDeskSubjectOptions>

ZENDESK_API_KEY: to generate an API token, you must enter into the Zendesk Admin center.

Admin Center - Zendesk

Now, on the sidebar, select the option Apps and Integrations > APIs > Zendesk API:

Apps and Integrations > APIs > Zendesk API

Activate the access usage token:

Zendesk API - Zendesk Admin Center

Then, you must click on "Add API Token" and complete the information to generate a token.

It is important that you copy the token when you are completing the information.

ZENDESK_EMAIL: refers to the support account.

ZENDESK_API_URL: URL according to the name of your institution.

ZENDESK_API_VERSION: API version to use.

ZENDESK_SUBJECT_OPTIONS: refers to the subject options that will be displayed in the support form (these options must be separated by a comma).

Environment Variables Example

ZENDESK_API_KEY=<your_api_key>
[email protected]
ZENDESK_API_URL=https://institucionName.zendesk.com
ZENDESK_API_VERSION=/api/v2
ZENDESK_SUBJECT_OPTIONS="Account Support,Suggestions,Others"