Zendesk Support v2

Zendesk Support is a ticketing platform used to manage support requests, users, organizations, comments, and related service-desk data through the Zendesk Ticketing API.

The Flowgear Zendesk Support Node lets you retrieve, create, and update the supported Zendesk Support records in a Workflow by using OAuth, embedded API metadata, and curated request templates.

Revision History

0.0.0.11 - Initial release.
0.1.0.0 - Retrieve now retrieves the first page, and Create and Update send the first item, before returning. Later pages and items are processed as the Workflow consumes rows.
0.1.1.0 - Cursor paging is now handled automatically for supported Retrieve operations.
0.1.1.1 - Designer templates now retain inherited fields when OpenAPI schemas use constraints-only allOf overlays.
0.1.1.2 - Maintenance release.
0.1.1.3 - Update items can now carry their own ticket_id, user_id, or organization_id, so one call can update different records without a For Each.

Connection

Use this Connection to store the Zendesk tenant and OAuth settings used by all Node methods.

Property Type Description
Subdomain String The Zendesk tenant subdomain, for example contoso when the tenant URL is contoso.zendesk.com.
Client ID String The OAuth client identifier issued by Zendesk.
Client Secret Masked The OAuth client secret issued by Zendesk.
Access Token Masked The OAuth access token used for Zendesk Support API requests.
Refresh Token Masked The OAuth refresh token used to renew the access token.
Timeout (seconds) Integer The timeout used for OAuth token requests, Connection validation, and API calls. It must be greater than zero. The default is 30.

Setup Notes

  1. Create or reuse a Zendesk OAuth client with access to the Ticketing API resources that your Workflow needs.
  2. Configure the OAuth client as a confidential client, then record the Client ID and Client Secret.
  3. Add the Flowgear OAuth callback URL to the Zendesk OAuth client's allowed redirect URLs.
  4. In Flowgear, create a Zendesk Support Connection and enter the Subdomain, Client ID, and Client Secret.
  5. Click Connect your Account, sign in to Zendesk, and authorize the application.
  6. Save and test the Connection.

The Node requests the read write OAuth scope. Connection validation calls Zendesk's current-user endpoint to confirm that the access token can reach the API.

Methods

The Node exposes template-driven Create, Retrieve, and Update methods for the curated Zendesk Support Ticketing API surface.

Create

Use Create for supported Zendesk Support POST operations, including ticket, user, and organization creation.

Parameter Type Description
Connection Connection Zendesk Support Connection details.
OperationId String The template-selected identifier for the operation to run.
Options Object Route and query values required by the selected operation.
Items Array Structured request body for the selected create operation.
Return Type Description
Response Array Mutation response rows for the selected operation. Rows preserve the provider payload and add the top-level Flowgear object with IsSuccess, Message, and Request.

Retrieve

Use Retrieve for supported Zendesk Support GET operations, including current user, tickets, ticket comments, users, organizations, and search export.

Parameter Type Description
Connection Connection Zendesk Support Connection details.
OperationId String The template-selected identifier for the operation to run.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array Zendesk response rows for the selected operation. Valid empty results return zero rows, and failures on the first provider call surface as errors instead of empty success rows.

Update

Use Update for supported Zendesk Support PUT operations, including ticket, user, and organization updates.

Parameter Type Description
Connection Connection Zendesk Support Connection details.
OperationId String The template-selected identifier for the operation to run.
Options Object Route and query values required by the selected operation. The route value, such as ticket_id, is used for every item that does not set its own.
Items Array Structured request body for the selected update operation. Each item can also set the record's route value, such as ticket_id, to update a different record per item.
Return Type Description
Response Array Mutation response rows for the selected operation. Rows preserve the provider payload and add the top-level Flowgear object with IsSuccess, Message, and Request.

Usage Notes

  • Templates populate OperationId and the expected Options values for the selected operation.
  • You can browse and expand templates without live Zendesk credentials because the Node uses an embedded OpenAPI document for template discovery.
  • Runtime API calls require a valid Zendesk Support Connection.
  • Retrieve fetches the first page before returning. Later pages are retrieved as the Workflow consumes rows for supported list and search-export operations, so Workflow designers do not need to pass page, per_page, page[size], page[after], or page[before].
  • The search export template requires query and filter[type]. The supported filter[type] values are ticket, user, and organization.
  • Write templates expose curated body fields for tickets, users, and organizations instead of the full tenant-specific Zendesk schema.
  • Retrieve rows return Zendesk data unchanged, emit zero rows for valid empty results, and surface failures on the first provider call as errors instead of returning error rows.
  • Create and Update send the first request item before returning. Later items are sent only as the Workflow consumes rows, and an empty connected Items stream performs no work.
  • Update accepts its route value (ticket_id, user_id, or organization_id) on each item as well as in Options, so one call can update many records without a For Each. An item's value overrides Options for that request only and is not sent in the Zendesk request body, but Flowgear.Request still shows it. The Update templates list the route value under Items with a sample but no default value.
  • If an Update item has no route value in either place, or its value is not text or a number, the Node returns a failed row for that item without calling Zendesk. Later items are still processed.
  • Create and Update rows add the top-level Flowgear object with IsSuccess, Message, and Request. Flowgear.Request contains only the values passed into the request. Rows also preserve provider diagnostics such as httpStatusCode, providerError, and providerStatus when available.
  • Zendesk business fields that conflict with Flowgear fields are preserved with provider-prefixed names, for example providerStatus.
  • Delete operations, ticket-comment write operations, and file uploads are not exposed by this Node.

See also