Home Nodes Zendesk Support

Zendesk Support

Create, update, search, and report on Zendesk Support resources - especially tickets - from a Flowgear Workflow using OAuth 2.0 and curated API samples.

Revision History

1.0.0.0 Initial release.
2.0.0.0 A long, long time ago.
3.0.0.0 Refresh: Rebuilt on Zendesk's Public Support API and OAuth, with various quality-of-life improvements.

Properties

Connection

Type: Connection Input
The Connection Property, which defines your Zendesk Support credentials for authentication.

Subdomain
Type: String Input
Your Zendesk subdomain (the part before .zendesk.com).

ClientId
Type: String Input
OAuth client ID from your Zendesk OAuth client; Zendesk calls this the Identifier.

ClientSecret
Type: Secret Input
OAuth client secret from your Zendesk OAuth client.

AccessToken
Type: Secret Input
Filled automatically after you authenticate by "Connecting your Account" (OAuth 2.0).

RefreshToken
Type: Secret Input
Filled automatically after you authenticate by "Connecting your Account" (OAuth 2.0).

OperationId

Type: String Static
Internal ID of the selected API sample. Selecting a sample populates this for you, along with Request, Response, and relevant parameters if available.

Description

Type: String Static
Short description of the selected sample operation.

Request

Type: JSON Input
Raw JSON request body. Only required for operations that accept a body (e.g. create or update).

Response

Type: JSON Output
Raw JSON response returned by Zendesk.

Custom Inputs

This Node supports Custom Input Properties. The appropriate properties are added when you pick a Node Sample. These properties resolve into parameters for the request URL (e.g. selecting a "Show Ticket"" sample adds ticket_id, which is inserted into /tickets/{ticket_id}).

Using the Node

1. Creating a OAuth Client in Zendesk

You need a Zendesk admin role.

In Zendesk Admin Center:
Click → Admin Center → Apps and integrations → Zendesk API → OAuth clients → ✎ Add OAuth client

  1. Enter a Name, Description, Company, and Identifier (this is the Client ID used in Flowgear). Only the Identifier is important. The rest are simply to help you identify between your OAuth clients.
  2. Set Client kind to Confidential.
  3. Set Redirect URLs to the following:
    • [https://app.flowgear.net/r/auth]
    • [https://appnext.flowgear.net/r/auth]
  4. Save to reveal your Client Secret. Store it somewhere securely.

3. Create the Connection

  1. In the Flowgear Console, click Connections.
  2. Add a new Connection of type Zendesk Support.
  3. Enter your Subdomain.
  4. Paste the Client ID (Identifier) and Client Secret from your Zendesk Support OAuth client from Step 1.
  5. Click Connect your Account.
  6. You will be redirected to a Zendesk Support login page using its authorisation URL. Sign in and grant the application access.
  7. Save your Connection.

After you authorise the application, Zendesk will redirect you back to Flowgear with an authorisation code. The platform automatically completes the OAuth 2.0 handshake by exchanging the code for an AccessToken and RefreshToken, which are securely stored within the Connection.

4. Test your Connection

  1. Click Test on the Connection.
  2. Flowgear will attempt a test API call to a generic Zendesk Support endpoint to ensure your credentials are valid.

If the test is successful (✓), your credentials are valid.
If it fails (✗), the test will return an error message, and you may need to re-authorise the Connection. If this problem persists, please contact support for assistance.

See Also