Reference

Authentication OAuth - User Login (Interactive)

Description

Authenticate through an interactive Zendesk login. Create an OAuth client in Zendesk Admin Center under Apps and integrations > APIs > Zendesk API > OAuth Clients. [API reference]

Instructions

Use OAuth - User Login (Interactive) when the integration should access Zendesk on behalf of a specific user.

During initial setup, a browser window opens and the user signs in to Zendesk and authorizes the application. No Zendesk password is stored in the connection.

  1. Sign in to Zendesk as an administrator.
  2. Go to Admin Center > Apps and integrations > APIs > Zendesk API.
  3. Open the OAuth Clients section and create an OAuth client.
  4. Enter a unique Client ID.
  5. Copy the generated Client Secret and store it securely.
  6. Configure the following Redirect URL for the OAuth client:
    https://zappysys.com/oauth
  7. In the ZappySys connection, enter your Zendesk Sub Domain, Client ID, Client Secret, and desired Permissions.
  8. Start the authorization process and sign in to Zendesk when the browser opens.
  9. Approve access when prompted.
  10. Click Test Connection.
Token renewal: Zendesk access tokens expire. ZappySys uses the OAuth refresh token to obtain new access tokens without requiring the user to sign in again. The latest refresh token must be stored securely because Zendesk rotates refresh tokens during renewal.
If the refresh token expires, is revoked, or cannot be restored from the saved connection, the interactive Zendesk login process must be performed again.

For unattended server-side integrations where you do not want to maintain a refresh token, consider OAuth - Client Credentials (Server-to-Server).

Parameters

Parameter Required Default value Options
Name: Domain

Label: Sub Domain (e.g. mycompany)

 YES
Name: ClientId

Label: ClientId

 YES
Name: ClientSecret

Label: ClientSecret

 YES
Name: Permissions

Label: Permissions

Select the OAuth permissions required by your integration. 		YES read write
Name Value
Full Access (Read + Write) read write
Read Only (All Resources) read
Tickets - Read Only tickets:read
Tickets - Read + Write tickets:read tickets:write
Users - Read Only users:read
Users - Read + Write users:read users:write
Organizations - Read Only organizations:read
Organizations - Read + Write organizations:read organizations:write
Groups - Read Only groups:read
Groups - Read + Write groups:read groups:write
Help Center - Read Only hc:read
Help Center - Read + Write hc:read hc:write
Name: RedirectUrl

Label: RedirectUrl

 YES https://zappysys.com/oauth
Name: RetryMode

Label: RetryMode

 RetryWhenStatusCodeMatch
Name Value
None None
RetryAny RetryAny
RetryWhenStatusCodeMatch RetryWhenStatusCodeMatch
Name: RetryStatusCodeList

Label: RetryStatusCodeList

 429
Name: RetryCountMax

Label: RetryCountMax

 5
Name: RetryMultiplyWaitTime

Label: RetryMultiplyWaitTime

 True