Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions docs-v2/integrations/all/zendesk.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
---
title: Zendesk
title: Zendesk (Helpdesk)
sidebarTitle: Zendesk
---

Integration template: [`zendesk`](https://nango.dev/providers.yaml)

<Note>
Zendesk has two kinds of OAuth apps:
- Helpdesk/support apps
- CRM apps

Nango currently only supports OAuth for the Helpdesk apps. If you need the CRM one supported reach out or contribute it :)
</Note>

## Features

| Feature | Status |
Expand All @@ -18,15 +26,17 @@ Integration template: [`zendesk`](https://nango.dev/providers.yaml)
<Tip>We can implement missing features in &lt;48h, just ask for it in the [community](https://nango.dev/slack).</Tip>
## Getting started

- [How to register an Application](https://developer.zendesk.com/api-reference/sales-crm/authentication/introduction/#application-registration)
- [OAuth-related docs](https://developer.zendesk.com/api-reference/sales-crm/authentication/introduction/)
- [List of OAuth scopes](https://developer.zendesk.com/api-reference/sales-crm/authentication/introduction/#scopes)
- [API](https://developer.zendesk.com/api-reference/sales-crm/authentication/introduction/#scopes:~:text=Reference-,SYNC%20API,-Introduction)
- [How to register an Application](https://support.zendesk.com/hc/en-us/articles/4408845965210-Using-OAuth-authentication-with-your-application#topic_s21_lfs_qk)
- [List of OAuth scopes](https://support.zendesk.com/hc/en-us/articles/4408845965210#topic_gql_kbd_gt)
- [Setting up a global oAuth client](https://developer.zendesk.com/documentation/marketplace/building-a-marketplace-app/set-up-a-global-oauth-client/)
- [API](https://developer.zendesk.com/api-reference/)

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

## API gotchas

- Make sure you specify the subdomain in the [Connection Configuration](/nango-auth/configuration) before starting an OAuth flow for Zendesk.
- Make sure to create a Zendesk OAuth app (`https://<USER-SUBDOMAIN>.zendesk.com/admin/apps-integrations/apis/zendesk-api/settings`), _not_ a Zendesk Sales CRM OAuth app.
- Zendesk oAuth apps [must be made "global"](https://developer.zendesk.com/documentation/marketplace/building-a-marketplace-app/set-up-a-global-oauth-client/) to connect to multiple `<USER-SUBDOMAIN>`s.

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/zendesk.mdx)</Note>
29 changes: 28 additions & 1 deletion docs-v2/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,11 @@ git clone https://github.com/NangoHQ/nango.git && cd nango && docker compose up

Your code snippet should will look similar to this:

```js
<Tabs>

<Tab title="Nango Cloud">

```js
import Nango from '@nangohq/frontend';

let nango = new Nango({ publicKey: '<PUBLIC-KEY-FROM-PROJECT-SETTINGS>' });
Expand All @@ -76,6 +80,29 @@ git clone https://github.com/NangoHQ/nango.git && cd nango && docker compose up
});
```

</Tab>

<Tab title="Localhost">

```js
import Nango from '@nangohq/frontend';

let nango = new Nango();

nango
.auth('<INTEGRATION-ID>', '<CONNECTION-ID>')
.then((result: { providerConfigKey: string, connectionId: string }) => {
// OAuth flow succeeded!
})
.catch((err: { message: string, type: string }) => {
// handle error
});
```

</Tab>

</Tabs>

5. **Fetch access tokens from the backend with the SDK or REST API**
In your backend you can use our [Node SDK](/sdks/node) or [Connections REST API](/api-reference/connection/get) to fetch always-fresh access tokens and run API requests.

Expand Down