library
turbot/zendesk
Get Involved
Version
Create Ticket
Create a ticket.
Run the pipeline
To run this pipeline from your terminal:
flowpipe pipeline run zendesk.pipeline.create_ticket \ --arg 'comment=<object>'
Use this pipeline
To call this pipeline from your pipeline, use a step:
step "pipeline" "step_name" { pipeline = zendesk.pipeline.create_ticket args = { comment = <object> }}
Params
Name | Type | Required | Description | Default |
---|---|---|---|---|
assignee_email | string | No | Write only. The email address of the agent to assign the ticket to. | - |
assignee_id | number | No | The agent currently assigned to the ticket. | - |
followers | list of object | No | Write only. An array of objects that represent agent followers to add or delete from the ticket. See Setting followers. | - |
allow_channelback | bool | No | Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket. | - |
is_public | bool | No | Is true if any comments are public, false otherwise. | - |
raw_subject | string | No | The dynamic content placeholder, if present, or the 'subject' value, if not. See Dynamic Content Items. | - |
satisfaction_rating | object | No | 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. | - |
tags | list of string | No | The array of tags applied to this ticket. | - |
via_id | number | No | Write only. For more information, see the Via object reference. | - |
brand_id | number | No | Enterprise only. The ID of the brand this ticket is associated with. | - |
macro_ids | list of number | No | POST requests only. List of macro IDs to be recorded in the ticket audit. | - |
safe_update | bool | No | 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. | - |
subject | string | No | The value of the subject field for this ticket. | - |
via_followup_source_id | number | No | POST requests only. The ID of a closed ticket when creating a follow-up ticket. See Creating a follow-up ticket. | - |
voice_comment | object | No | Write only. See Creating voicemail ticket. | - |
collaborator_ids | list of number | No | The IDs of users currently CC'ed on the ticket. | - |
from_messaging_channel | bool | No | If true, the ticket's via type is a messaging channel. | - |
ticket_form_id | number | No | Enterprise only. The ID of the ticket form to render for the ticket. | - |
updated_stamp | string | No | Write only. Datetime of last update received from API. See the safe_update property. | - |
comment | object | Yes | An object that defines the properties of the ticket comment. | - |
allow_attachments | bool | No | Permission for agents to add attachments to a comment. Defaults to true. | - |
group_id | number | No | The group this ticket is assigned to. | - |
description | string | No | Read-only first comment on the ticket. When creating a ticket, use comment to set the description. See Description and first comment. | - |
metadata | map of dynamic | No | 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. | - |
requester | object | No | Write only. See Creating a ticket with a new requester. | - |
followup_ids | list of number | No | The IDs of the followups created from this ticket. IDs are only visible once the ticket is closed. | - |
via | object | No | For more information, see the Via object reference. | - |
custom_status_id | number | No | The custom ticket status ID of the ticket. See custom ticket statuses. | - |
follower_ids | list of number | No | The IDs of agents currently following the ticket. See CCs and followers resources. | - |
url | string | No | The API URL of this ticket. | - |
collaborators | list of object | No | POST requests only. Users to add as CC's when creating a ticket. See Setting Collaborators. | - |
sharing_agreement_ids | list of number | No | The IDs of the sharing agreements used for this ticket. | - |
due_at | string | No | If this is a ticket of type 'task', it has a due date. Due date format uses ISO 8601 format. | - |
priority | string | No | The urgency with which the ticket should be addressed. Allowed values are 'urgent', 'high', 'normal', or 'low'. | - |
attribute_value_ids | list of number | No | Write only. An array of the IDs of attribute values to be associated with the ticket. | - |
custom_fields | list of object | No | Custom fields for the ticket. See Setting custom field values. | - |
recipient | string | No | The original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address. | - |
updated_at | string | No | When this record last got updated. | - |
email_ccs | list of object | No | 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. | - |
type | string | No | The type of this ticket. Allowed values are 'problem', 'incident', 'question', or 'task'. | - |
forum_topic_id | number | No | The topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated. | - |
problem_id | number | No | For tickets of type 'incident', the ID of the problem the incident is linked to. | - |
submitter_id | number | No | The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket. | - |
email_cc_ids | list of number | No | The IDs of agents or end users currently CC'ed on the ticket. See CCs and followers resources in the Support Help Center. | - |
ticket_id | number | No | Automatically assigned when the ticket is created. | - |
requester_id | number | No | The user who requested this ticket. | - |
cred | string | Yes | Name for credentials to use. If not provided, the default credentials will be used. | default |
external_id | string | No | An ID you can use to link Zendesk Support tickets to local records. | - |
macro_id | number | No | Write only. A macro ID to be recorded in the ticket audit. | - |
created_at | string | No | When this record was created. | - |
has_incidents | bool | No | Is true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false. | - |
organization_id | number | No | The organization of the requester. You can only specify the ID of an organization associated with the requester. See Organization Memberships. | - |
status | string | No | 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'. | - |
Outputs
Name | Description |
---|---|
ticket | The ticket that has been created. |