zendesk

API configuration: zendesk

Zendesk has two kinds of OAuth apps:

• Helpdesk/support apps

• CRM apps

Terapi currently only supports OAuth for the Helpdesk apps. If you need CRM, reach out or contribute it :)

Features

Features	Status
Auth (OAuth)	✅
Sync data	✅
Perform workflows	✅
Proxy requests	✅
Receive webhooks	🚫 (time to contribute: <48h)

We can implement missing features in <48h, just ask for it in the community.

Getting started

• How to register an Application

• List of OAuth scopes

• Setting up a global oAuth client

• API

Do you need help? Please check this link community.

Connection configuration in Terapi

Zendesk requires a user specific subdomain to run OAuth.

You should request this from the user and pass it to Terapi in the terapi.auth() call:

terapi.auth('zendesk', '', {params: {subdomain: ''}});

For more details, see the docs here.

API gotchas

• Make sure to create a Zendesk OAuth app (https://.zendesk.com/admin/apps-integrations/apis/zendesk-api/settings), not a Zendesk Sales CRM OAuth app.

• Zendesk oAuth apps must be made "global" to connect to multiple ``s.

Add Getting Started links and Gotchas by editing this page