Zendesk

Create, update, and search tickets, and add comments in Zendesk.

Customer supportAPI key13 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (13)
create-ticket
find-tickets
add-comment-to-ticket
add-tag-to-ticket
create-organization
create-user
custom_api_call
delete-user
find-organization
find-user
update-organization
update-ticket
update-user
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("zendesk", "create-ticket", {
    "organization_id": "<organization_id>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Zendesk answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "zendesk-create-ticket",
  name: "Zendesk: Create Ticket",
  description: "Calls Zendesk when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("zendesk", {
      "action": "create-ticket",
      "organization_id": "<organization_id>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/zendesk/create-ticket" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"organization_id":"<organization_id>"}}'

Actions

create-ticketin catalog

Create Ticket. Create a new ticket in Zendesk.

Input	Type	Description
`subject`optional	text	The subject of the ticket (optional - will use first comment text if not provided)
`comment_body`optional	long text	The comment body (text). Use this for plain text comments.
`comment_html_body`optional	long text	The comment body (HTML). Use this for HTML formatted comments. If provided, this takes precedence over Comment Body.
`requester_email`optional	text	Email address of the ticket requester. If not provided, the authenticated user will be the requester.
`requester_name`optional	text	Name of the ticket requester (used when creating a new user).
`assignee_email`optional	text	Email address of the agent to assign the ticket to.
`priority`optional	one of "low" \| "normal" \| "high" \| "urgent"	The priority of the ticket.
`type`optional	one of "problem" \| "incident" \| "question" \| "task"	The type of ticket.
`status`optional	one of "new" \| "open" \| "pending" \| "hold" \| "solved" \| "closed"	The status of the ticket.
`tags`optional	array	Array of tags to apply to the ticket.
`organization_id`required	id (picked from your account)	Select the organization to work with
`group_id`optional	id (picked from your account)	Select the group to assign
`external_id`optional	text	An external ID for the ticket (useful for integrations).
`collaborator_emails`optional	array	Array of email addresses to add as collaborators.
`follower_emails`optional	array	Array of email addresses to add as followers.
`due_at`optional	date-time (ISO)	The date and time when the ticket is due.
`custom_fields`optional	object (depends on other props)	Custom ticket field values
`comment_public`optional	boolean	Whether the comment is public (visible to the requester). Defaults to true.
`brand_id`optional	id (picked from your account)	Select the brand to work with
`forum_topic_id`optional	number	The ID of the forum topic associated with the ticket.

find-ticketsin catalog

Find Ticket(s). Search tickets by ID, field, or content.

Input	Type	Description
`search_type`required	one of "id" \| "status" \| "priority" \| "type" \| "tag" \| "requester" \| "assignee" \| "content" \| "custom"	Choose how to search for tickets
`timeFilter`optional	array	Date Time Filter
`ticket_id`optional	text	The ID of the ticket to find
`status`optional	one of "new" \| "open" \| "pending" \| "hold" \| "solved" \| "closed"	Search tickets by status
`priority`optional	one of "low" \| "normal" \| "high" \| "urgent"	Search tickets by priority
`ticket_type`optional	one of "problem" \| "incident" \| "question" \| "task"	Search tickets by type
`tag`optional	text	Search tickets containing this tag
`requester_email`optional	text	Search tickets by requester email address
`assignee_email`optional	text	Search tickets by assignee email address
`content`optional	text	Search in ticket subject and content
`custom_query`optional	long text	Custom search query using Zendesk search syntax (e.g., "type:ticket status:open priority:high")
`sort_by`optional	one of "relevance" \| "created_at" \| "updated_at" \| "priority" \| "status" \| "ticket_type"	How to sort the results
`sort_order`optional	one of "desc" \| "asc"	Sort order for results

add-comment-to-ticket

Add Comment to Ticket. Append a public/private comment to a ticket.

Input	Type	Description
`ticket_id`required	id (picked from your account)	Select the ticket to work with
`comment_body`optional	long text	The comment text content
`comment_html_body`optional	long text	HTML formatted comment (takes precedence over text)
`public`optional	boolean	Make comment visible to requester (default: true)
`author_email`optional	text	Email of comment author (defaults to authenticated user)
`uploads`optional	array	Upload tokens for file attachments
`via_followup_source_id`optional	number	Original ticket ID if this is from a follow-up

add-tag-to-ticket

Add Tag to Ticket. Apply one or more tags to a ticket.

Input	Type	Description
`ticket_id`required	id (picked from your account)	Select the ticket to work with
`tags`required	array	Tags to add to the ticket (adds to existing tags)
`safe_update`optional	boolean	Prevent tag loss from concurrent updates
`updated_stamp`optional	text	Ticket timestamp from updated_at field for collision prevention

create-organization

Create Organization. Create a new organization record.

Input	Type	Description
`name`required	text	Unique name for the organization
`details`optional	long text	Additional details about the organization
`notes`optional	long text	Internal notes about the organization
`external_id`optional	text	External ID for integration purposes
`group_id`optional	id (picked from your account)	Select the group to assign
`domain_names`optional	array	Domain names associated with the organization
`tags`optional	array	Tags to apply to the organization
`organization_fields`optional	object (depends on other props)	Custom organization field values
`shared_tickets`optional	boolean	Allow users to see each other's tickets
`shared_comments`optional	boolean	Allow users to see each other's comments

create-user

Create User. Add a new user to the Zendesk instance.

Input	Type	Description
`name`required	text	The name of the user
`email`optional	text	The primary email address of the user
`role`optional	one of "end-user" \| "agent" \| "admin"	The role of the user. Defaults to "end-user" if not specified.
`custom_role_id`optional	id (picked from your account)	Select the custom role for the agent
`organization_id`required	id (picked from your account)	Select the organization to work with
`organization_name`optional	text	Create and associate user with a new organization by name (alternative to Organization ID)
`phone`optional	text	The phone number of the user
`alias`optional	text	An alias displayed to end users
`details`optional	long text	Additional details about the user
`notes`optional	long text	Internal notes about the user
`external_id`optional	text	A unique external ID for the user (useful for integrations)
`time_zone`optional	text	The time zone of the user (e.g., "America/New_York")
`locale`optional	text	The locale of the user (e.g., "en-US")
`verified`optional	boolean	Whether the user is verified
`active`optional	boolean	Whether the user is active. Defaults to true.
`shared`optional	boolean	Whether the user is shared from a different Zendesk Support instance
`shared_agent`optional	boolean	Whether the user is a shared agent from a different Zendesk Support instance
`moderator`optional	boolean	Whether the user has forum moderation capabilities
`suspended`optional	boolean	Whether the user is suspended
`restricted_agent`optional	boolean	Whether the agent has restrictions on what tickets they can access

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

delete-user

Delete User. Remove a user and associated records from the account.

Input	Type	Description
`user_id`required	id (picked from your account)	Select the user to work with
`confirmation`required	boolean	I understand that deleted users are not recoverable and this action cannot be undone.

find-organization

Find Organization(s). Search organizations by name, domain, external ID, or other criteria.

Input	Type	Description
`search_type`required	one of "name" \| "domain" \| "external_id" \| "tag" \| "details" \| "custom"	Choose how to search for organizations
`name`optional	text	The name of the organization to search for
`domain`optional	text	Search organizations by domain name
`external_id`optional	text	Search organizations by external ID
`tag`optional	text	Search organizations containing this tag
`details`optional	text	Search in organization details/notes
`custom_query`optional	long text	Custom search query using Zendesk search syntax (e.g., "type:organization domain:example.com")
`sort_by`optional	one of "relevance" \| "created_at" \| "updated_at"	How to sort the results
`sort_order`optional	one of "desc" \| "asc"	Sort order for results

find-user

Find User(s). Search users by email, name, role, or other criteria.

Input	Type	Description
`search_type`required	one of "email" \| "name" \| "role" \| "organization" \| "tag" \| "external_id" \| "custom"	Choose how to search for users
`email`optional	text	The email address of the user to search for
`name`optional	text	The name of the user to search for
`role`optional	one of "end-user" \| "agent" \| "admin"	Search users by role
`organization`optional	text	Search users by organization name
`tag`optional	text	Search users containing this tag
`external_id`optional	text	Search users by external ID
`custom_query`optional	long text	Custom search query using Zendesk search syntax (e.g., "type:user role:agent")
`sort_by`optional	one of "relevance" \| "created_at" \| "updated_at"	How to sort the results
`sort_order`optional	one of "desc" \| "asc"	Sort order for results

update-organization

Update Organization. Update existing organization fields.

Input	Type	Description
`organization_id`required	id (picked from your account)	Select the organization to work with
`name`optional	text	New name for the organization (must be unique)
`details`optional	long text	Additional details about the organization
`notes`optional	long text	Internal notes about the organization
`external_id`optional	text	External ID for integration purposes
`group_id`optional	id (picked from your account)	Select the group to assign
`domain_names`optional	array	Domain names for the organization (replaces all existing)
`tags`optional	array	Tags for the organization (replaces all existing)
`organization_fields`optional	object (depends on other props)	Custom organization field values
`shared_tickets`optional	boolean	Allow users to see each other's tickets
`shared_comments`optional	boolean	Allow users to see each other's comments

update-ticket

Update Ticket. Modify ticket fields or status via API call.

Input	Type	Description
`ticket_id`required	id (picked from your account)	Select the ticket to work with
`subject`optional	text	Update the subject of the ticket
`comment_body`optional	long text	Add a comment to the ticket (plain text)
`comment_html_body`optional	long text	Add a comment to the ticket (HTML). If provided, this takes precedence over Comment Body.
`comment_public`optional	boolean	Whether the comment is public (visible to the requester). Defaults to true.
`assignee_email`optional	text	Email address of the agent to assign the ticket to
`priority`optional	one of "low" \| "normal" \| "high" \| "urgent"	Update the priority of the ticket
`type`optional	one of "problem" \| "incident" \| "question" \| "task"	Update the type of ticket
`status`optional	one of "new" \| "open" \| "pending" \| "hold" \| "solved" \| "closed"	Update the status of the ticket
`tags`optional	array	Replace all tags with this array. Use "Add Tag to Ticket" action to add tags without replacing existing ones.
`organization_id`required	id (picked from your account)	Select the organization to work with
`group_id`optional	id (picked from your account)	Select the group to assign
`external_id`optional	text	Update the external ID for the ticket
`due_at`optional	date-time (ISO)	Update the date and time when the ticket is due
`custom_fields`optional	object (depends on other props)	Update custom ticket field values
`custom_status_id`optional	number	Set a custom status ID for the ticket
`forum_topic_id`optional	number	Update the forum topic associated with the ticket
`collaborator_emails`optional	array	Replace collaborators with this array of email addresses
`follower_emails`optional	array	Replace followers with this array of email addresses
`requester_email`optional	text	Update the requester of the ticket

update-user

Update User. Update existing user fields.

Input	Type	Description
`user_id`required	text	The ID of the user to update.
`name`optional	text	New name for the user.
`email`optional	text	New email address for the user.
`phone`optional	text	New phone number for the user.
`tags`optional	array	Tags for the user. This replaces all existing tags.
`user_fields`optional	object (depends on other props)	Custom user field values.

Details

Id: zendesk
Category: Customer support
Tags: helpdesk, tickets, support, customer-service
Package: @activepieces/piece-zendesk@0.2.6
Tier: Built in