Run pipelines to supercharge your Zendesk workflows using Flowpipe.

zendesk

zendesk.pipeline.create_ticket

ticket

Name for credentials to use. If not provided, the default credentials will be used.

cred

An object that defines the properties of the ticket comment.

comment

Permission for agents to add attachments to a comment. Defaults to true.

allow_attachments

Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket.

allow_channelback

Write only. The email address of the agent to assign the ticket to.

assignee_email

The agent currently assigned to the ticket.

assignee_id

Write only. An array of the IDs of attribute values to be associated with the ticket.

attribute_value_ids

Enterprise only. The ID of the brand this ticket is associated with.

brand_id

The IDs of users currently CC'ed on the ticket.

collaborator_ids

POST requests only. Users to add as CC's when creating a ticket. See Setting Collaborators.

collaborators

created_at

Custom fields for the ticket. See Setting custom field values.

custom_fields

The custom ticket status ID of the ticket. See custom ticket statuses.

custom_status_id

Read-only first comment on the ticket. When creating a ticket, use comment to set the description. See Description and first comment.

description

If this is a ticket of type 'task', it has a due date. Due date format uses ISO 8601 format.

due_at

The IDs of agents or end users currently CC'ed on the ticket. See CCs and followers resources in the Support Help Center.

email_cc_ids

Write only. An array of objects that represent agent or end users email CCs to add or delete from the ticket. See Setting email CCs.

email_ccs

An ID you can use to link Zendesk Support tickets to local records.

external_id

The IDs of agents currently following the ticket. See CCs and followers resources.

follower_ids

Write only. An array of objects that represent agent followers to add or delete from the ticket. See Setting followers.

followers

The IDs of the followups created from this ticket. IDs are only visible once the ticket is closed.

followup_ids

The topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated.

forum_topic_id

If true, the ticket's via type is a messaging channel.

from_messaging_channel

group_id

Is true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false.

has_incidents

Automatically assigned when the ticket is created.

ticket_id

Is true if any comments are public, false otherwise.

is_public

Write only. A macro ID to be recorded in the ticket audit.

macro_id

POST requests only. List of macro IDs to be recorded in the ticket audit.

macro_ids

Write only. Metadata for the audit. In the audit object, the data is specified in the custom property of the metadata object. See Setting Metadata.

metadata

The organization of the requester. You can only specify the ID of an organization associated with the requester. See Organization Memberships.

organization_id

The urgency with which the ticket should be addressed. Allowed values are 'urgent', 'high', 'normal', or 'low'.

priority

For tickets of type 'incident', the ID of the problem the incident is linked to.

problem_id

The dynamic content placeholder, if present, or the 'subject' value, if not. See Dynamic Content Items.

raw_subject

The original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address.

recipient

Write only. See Creating a ticket with a new requester.

requester

requester_id

Write only. Optional boolean. When true and an update_stamp date is included, protects against ticket update collisions and returns a message to let you know if one occurs. See Protecting against ticket update collisions. A value of false has the same effect as true. Omit the property to force the updates to not be safe.

safe_update

The satisfaction rating of the ticket, if it exists, or the state of satisfaction, 'offered' or 'unoffered'. The value is null for plan types that don't support CSAT.

satisfaction_rating

The IDs of the sharing agreements used for this ticket.

sharing_agreement_ids

The state of the ticket. If your account has activated custom ticket statuses, this is the ticket's status category. See custom ticket statuses. Allowed values are 'new', 'open', 'pending', 'hold', 'solved', or 'closed'.

status

The value of the subject field for this ticket.

subject

The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket.

submitter_id

The array of tags applied to this ticket.

ticket_form_id

The type of this ticket. Allowed values are 'problem', 'incident', 'question', or 'task'.

type

updated_at

Write only. Datetime of last update received from API. See the safe_update property.

updated_stamp

For more information, see the Via object reference.

POST requests only. The ID of a closed ticket when creating a follow-up ticket. See Creating a follow-up ticket.

via_followup_source_id

Write only. For more information, see the Via object reference.

via_id

Write only. See Creating voicemail ticket.

voice_comment

create_ticket

Create Ticket

zendesk.pipeline.create_user

user

email

name

role

create_user

Create User

zendesk.pipeline.delete_ticket

delete_ticket

Delete Ticket

zendesk.pipeline.delete_user

user_id

delete_user

Delete User

zendesk.pipeline.get_ticket

get_ticket

Get Ticket

zendesk.pipeline.get_ticket_comments_count

The number of ticket comments in an account.

ticket_comments_count

get_ticket_comments_count

Count Ticket Comments

zendesk.pipeline.get_tickets_count

tickets_count

get_tickets_count

Count Tickets

zendesk.pipeline.get_user

The user ID of the user that is being displayed.

get_user

Get User

zendesk.pipeline.get_users_count

The number of users associated to the account.

users_count

get_users_count

Count Users

zendesk.pipeline.list_deleted_tickets

The list of users associated to the account.

deleted_tickets

list_deleted_tickets

List Deleted Tickets

zendesk.pipeline.list_ticket_comments

ticket_comments

Include 'users' to list email CCs by side-loading users.

include

Include inline images in the response (default is false).

include_inline_images

list_ticket_comments

List Ticket Comments

zendesk.pipeline.list_ticket_followers

ticket_followers

list_ticket_followers

List Ticket Followers

zendesk.pipeline.list_tickets

tickets

list_tickets

List Tickets

zendesk.pipeline.list_users

users

list_users

List Users

Mark a ticket as spam and suspend the user.

zendesk.pipeline.mark_ticket_as_spam

mark_ticket_as_spam

Mark Ticket as Spam

zendesk.pipeline.update_ticket_comment

update_ticket_comment

Update Ticket Comment

zendesk.pipeline.update_ticket_status

update_ticket_status

Update Ticket Status

zendesk.pipeline.update_user

The updated state of the user whether suspended or not.

suspended_status

The updated remote photo url of the user.

Pipelines