X

Events

Actions

Home > Application Reference > Zendesk OAuth

Jump to a Section

Events

  • New Comment On Ticket

    This card monitors all Zendesk tickets for new comments.

    NOTE: It takes up to 15 minutes for new or updated records in Zendesk to hit the Zendesk API, meaning the designer can’t read new or updated records for at least 15 minutes after the time they are created. This means that the Run Now feature won’t work for testing Flows that start with a Zendesk monitor. Please wait 20 minutes after creating or updating records for the monitor to run naturally in order to test Zendesk monitors in your Flows.

    Output field

    • Comment type (dropdown menu)

      • Public reply : This event will only be triggered for new public comments.
      • Internal : This event will only be triggered for new private comments.
      • All : This event will be triggered for all new comments.

    • Comment

      • Comment ID (number) : A unique identification code for comment.
      • Ticket ID (number) : A unique identification code for ticket.
      • Body (text) : The commment in text.
      • Body(HTML) (text) : The comment with HTML.
      • AuthorID (number) : The user Id of the the comment’s author.
      • AttachmentID (list of number) : A comma-delimited list of attachment IDs associated with the comment.
      • Via Channel (text): A description of how the ticket was created (ex: “api, “web”, “mobile”).
      • Created At (text) : Date and time that the ticket was created (ex: 2016-05-24T13:41:22Z).
      • Public? (true/false) : True if the comment is a public comment.  False otherwise.

  • New Comment On Ticket Webhook

    Start a Flow when a new comment is added to a ticket.

    Output Fields

    • Comment
      • Comment ID (number) : A unique identification code for comment.
      • Ticket ID (number) : A unique identification code for ticket.
      • Body (text) : The commment in text.
      • Body(HTML) (text) : The comment with HTML.
      • AuthorID (number) : The user Id of the the comment’s author.
      • AttachmentID (list of number) : A comma-delimited list of attachment IDs associated with the comment.
      • Via Channel (text) A description of how the ticket was created (ex: “api, “web”, “mobile”).
      • Created At (text) : Date and time that the ticket was created (ex: 2016-05-24T13:41:22Z).
      • Public? (true/false) : True if the comment is a public comment.  False otherwise.

  • New End User

    Start Flow when a new end-user is created.

    NOTE: It takes up to 15 minutes for new or updated records in Zendesk to hit the Zendesk API, meaning the designer can’t read new or updated records for at least 15 minutes after the time they are created. This means that the Run Now feature won’t work for testing Flows that start with a Zendesk monitor. Please wait 20 minutes after creating or updating records for the monitor to run naturally in order to test Zendesk monitors in your Flows.

    Outputs Fields

    • User
      • User ID (number) : The user indentification code of the user.
      • Name (text) : The text name of the user.
      • Email (text) : The user’s primary email address.
      • Phone (text) : The user’s primary phone number.
      • Alias (text) : The user’s alias which is displayed to end-users.
      • Role (text) : The role of the user.  Can be “agent”, “end-user”, or “admin”.
      • Locale (text) : The locale of the user.
      • Locale ID (text) : The identification code of the user language.
      • Time Zone (text) : The user’s timezone. See Time Zone..
      • Created At (text) : Date and time that the user was created (ex: 2016-05-24T13:41:53Z).
      • Updated At (text) : Date and time that the user was most recently updated.
      • Active? (true/false) : Returns ‘false’ of the user has been deleted.
      • Verified? (true/false) : Returns ‘true’ if the user’s identity has been verified.
      • Shared? (true/false) : Returns ‘true’ if the user is shared from another Zendesk instance.
      • Shared Agent? (text) : Returns ‘true’ if the user is an agent that is shared from another Zendesk instance.
      • Suspended? (text) : Returns ‘true’ if the user is currenly suspended.
      • Tags (list of text) : A comma-delimited list of tags associated with the user.
    • Custom Fields : Dynamically generated field that depends on the user. More on custom Fields.

  • New Organization

    Start Flow when a new organization is created.

    NOTE: It takes up to 15 minutes for new or updated records in Zendesk to hit the Zendesk API, meaning the designer can’t read new or updated records for at least 15 minutes after the time they are created. This means that the Run Now feature won’t work for testing Flows that start with a Zendesk monitor. Please wait 20 minutes after creating or updating records for the monitor to run naturally in order to test Zendesk monitors in your Flows.

    Output Fields

    • Organization
      • Organization ID (number) : The ID of the organization.
      • External ID (text) : The URL of the organization.
      • Name (text) : The name of the organization.
      • Created At (text) : Date and time that the organization was created (ex: 2016-05-24T13:41:22Z).
      • Updated At (text) : Date and time that the ticket was most recently updated.
      • Domain Names (list of text) : A comma-delimited list of domain names associated with the organization, if any.
      • Details (text) : Any details about the organization.
      • Notes (text) :  Any notes about the organization.
      • Group ID (number) : New tickets created by users of this organization will automatically be assigned to this group ID.
      • Shared Tickets? (true/false) : ‘True’ if end-users in this organization are able to see each other’s tickets. ‘False’ otherwise.
      • Shared Comments? (true/false) : ‘True’ if end-users in this organization are able to see each each other’s comments on tickets.  ’False’ otherwise.
      • Tags (list of text) : A comma-delimited list of tags associated with this organization.
    • Custom Fields : A dynamically generated list of any custom fields associated with the organization. More on custom Fields.

  • New Ticket

    Start Flow when a new ticket is created.

    This card monitors for tickets that are added within Zendesk. NOTE: It takes up to 15 minutes for new or updated records in Zendesk to hit the Zendesk API, meaning the designer can’t read new or updated records for at least 15 minutes after the time they are created. This means that the Run Now feature won’t work for testing Flows that start with a Zendesk monitor. Please wait 20 minutes after creating or updating records for the monitor to run naturally in order to test Zendesk monitors in your Flows.

    Output Fields

    • Ticket
      • Ticket ID (number) : The ID of the ticket.
      • Subject (text) : The subject of the ticket.
      • Description (text) : The first comment on a ticket.
      • Type (text) : The type of ticket.  Can be “problem”, “incident”, “question” or “task”.
      • External ID (text) : An ID that you can assign to match this ticket with your own records.
      • Priority (text) : The priority of the ticket. Can be “urgent”, “high”, “normal”, or “low”.
      • Status (text) : The state of the ticket.  Can be “new”, “open”, “pending”, “hold”, “solved”, or “closed”.
      • Recipient Email (text) : The email address of the original recipient of the ticket.
      • Requester ID (number) : The ID of the user who requested the ticket.
      • Submitter ID (number) :The ID of the user who submitted the ticket.  The submitter is the author of the first comment on the ticket.
      • Assignee ID (number) : The ID of the agent to whom the ticket is assigned.
      • Organization ID (number) :  The ID of the organization of that the requester belongs to.
      • Group ID (number) : The ID of the group the user is assigned to.
      • Collaborator ID (list of number) : A comma-delimited list of the IDs of the users who are currently CC’d on the ticket.
      • Forum Topic ID (number) : The ID of the forum topic that the ticket originated from, if any.
      • Problem ID (number) : The ID of the problem that the ticket (if incident) is linked to, if any.
      • Has Incident ID (true/false) : Returns ‘true’ if the ticket type is ‘problem’.  Returns ‘false’ otherwise.
      • Due At (text) : If this is a ticket of type “task” it has a due date. Due date format uses ISO 8601 format.
      • Tags (list of text) : A comma-delimited list of the tags associated with the ticket.
      • Via Channel (text) : A description of how the ticket was created (ex: “api”, “web”, “mobile”).
      • Satisfication Score (number) : The satisfaction rating of the ticket, or the state of satisfaction (“offered” or “unoffered”).
      • Satisfication Comment (text) : The comment(s) associated with the satisfaction rating, if any.
      • Sharing Agreement ID (list of number) : A comma-delimited list of the sharing agreement IDs used for this ticket.
      • Ticket Form ID (number) : The ID of the ticket form that was used to render this ticket, if any.
      • Brand ID (number) : The ID of the brand associated with this ticket.
      • Public? (true/false) : True if the comment is a public comment.  False otherwise.
      • Created At (text) : Date and time that the organization was created (ex: 2016-05-24T13:41:22Z).
      • Updated At (text) : Date and time that the ticket was most recently updated.
    • Custom Fields :A dynamically generated list of any custom fields associated with the ticket. More on custom Fields.

  • New Ticket Web Hook

    Start Flow when a new ticket is created.

    Output Fields

    • Ticket
      • Ticket URL (text): The website URL the ticket is associated with.
      • External ID (text): A unique id you can use to link Zendesk Support tickets to local records.
      • Created At (date): Time and date organization was created.
      • Updated At (date): Time and date organization was last updated.
      • Type (text): The type of this ticket, i.e. “problem”, “incident”, “question”, or “task”.
      • Subject (text): The value of the subject field for this ticket.
      • Description* (text): The first comment on the ticket (header for ticket).
      • Priority (text): Priority defines the urgency with which the ticket should be addressed, “urgent”, “high”, “normal”, and “low”.
      • Status (text): The state of the ticket , “new, “open”, “pending”, “hold”, “solved”, or “closed”.
      • Recipient (text): The original recipient e-mail address of the ticket.
      • Requester ID (number): Identification code of  user who requested this ticket.
      • Submitter ID (number): Identification code of the user who submitted the ticket; The submitter always becomes the author of the first comment on the ticket.
      • Assignee ID (number): Identification code of what agent is currently assigned to the ticket.
      • Collaborator ID (number): Identification code of who is currently CC’ed on the ticket.
      • Group ID (number): Identification number of the group this ticket is assigned to.
      • Forum Topic ID (number): The topic this ticket originated from, if any.
      • Problem ID(number): Identification code of the problem this incident is linked to, if any.
      • Has Incidents? (yes or no): Is true of this ticket has been marked as a problem, false otherwise.
      • Due At (date): If this is a ticket of type “task” it has a due date. Due date format uses ISO 8601 format.
      • Tags (list): The array of tags applied to this ticket.
      • Via Channel (text): This object explains how the ticket was created using channels.
      • Satisfaction Score (text): The rating: “offered”, “unoffered”, “good” or “bad”.
      • Satisfaction Comment (text): The comment received with this rating, if available.
      • Sharing Agreement IDs (list): The ids of the sharing agreements used for this ticket.
      • Ticket Form ID (number): The Id of the ticket form to render for this ticket - only applicable for enterprise accounts.
      • Brand ID (number): The Id of the brand this ticket is associated with - only applicable for enterprise accounts.
    • Custom Fields : A dynamically generated list of any custom fields associated with the ticket. More on custom Fields.

  • Updated End User

    Monitor Zendesk for any update on a user that is in contact list.

    Output Fields

    • User
      • User ID (number) : The user indentification code of the user.
      • Name (text) : The text name of the user.
      • Email (text) : The user’s primary email address.
      • Phone (text) : The user’s primary phone number.
      • Alias (text) : The user’s alias which is displayed to end-users.
      • Role (text) : The role of the user.  Can be “agent”, “end-user”, or “admin”.
      • Locale (text) : The locale of the user.
      • Locale ID (text) : The identification code of the user language.
      • Time Zone (text) : The user’s timezone using tz database names. See Time Zone..
      • Created At (text) : Date and time that the user was created (ex: 2016-05-24T13:41:53Z).
      • Updated At (text) : Date and time that the user was most recently updated.
      • Active? (true/false) : Returns ‘false’ of the user has been deleted.
      • Verified? (true/false) : Returns ‘true’ if the user’s identity has been verified.
      • Shared? (true/false) : Returns ‘true’ if the user is shared from another Zendesk instance.
      • Shared Agent? (text) : Returns ‘true’ if the user is an agent that is shared from another Zendesk instance.
      • Suspended? (text) : Returns ‘true’ if the user is currenly suspended.
      • Tags (list of text) : A comma-delimited list of tags associated with the user.
    • Custom Fields : A dynamically generated list of any custom fields associated with the user. More on custom Fields.

  • Updated Organization

    Run Flow when updates are made to any organization’s fields.

    Output Fields

    • Organization

      • Organization ID (number): The unique identification code of organization user is associated with.
      • Organization URL (text): The URL of the organization website.
      • External ID (text): A unique indentification code you can specify for the user, to use externally.
      • Name (text): Name of user searched.
      • Created At (date): Time and date organization was created. This will be a year-month-day format.
      • Updated At (date): Time and date organization was last updated.
      • Domain Names (list): Drop down menu of possible domain names to associate with organization.
      • Details (text): Any details you want to store about the user, such as an address, age, hobby.
      • Notes (text): Any extra notes you want to store about the user.
      • Group ID (number): The unique identification number of group organization is associated with.
      • Shared Tickets? (true or false): If true is marked, tickets are not shared.
      • Shared Comments? (true or false):true if the comments within organization are shared, false otherwise.
      • Tags (list): Drop down menu of available tags related to organization.

    • Custom Fields : A dynamically generated list of any custom fields associated with the organization. More on custom Fields.

  • Updated Ticket

    This card monitors for tickets that are updated within Zendesk. NOTE: It takes up to 15 minutes for new or updated records in Zendesk to hit the Zendesk API, meaning the designer can’t read new or updated records for at least 15 minutes after the time they are created. This means that the Run Now feature won’t work for testing Flows that start with a Zendesk monitor. Please wait 20 minutes after creating or updating records for the monitor to run naturally in order to test Zendesk monitors in your Flows.

    Output Fields

    Any custom fields that exist will appear under ‘Record’.

    • Record
      • id (text): The ID of the ticket.
      • _url_ (text): The URL of the ticket.
      • _external_id_ (text): An ID that you can assign to match this ticket with your own records.
      • type (text): The type of ticket.  Can be “problem”, “incident”, “question” or “task”.
      • _subject_ (text): The subject of the ticket.
      • _description_ (text): The first comment on a ticket.
      • priority (text): The priority of the ticket. Can be “urgent”, “high”, “normal”, or “low”.
      • status (text): The state of the ticket.  Can be “new”, “open”, “pending”, “hold”, “solved”, or “closed”.
      • _recipient_ (text): The email address of the original recipient of the ticket.
      • _requestedid (text): The ID of the user who requested the ticket.
      • _submitterid (text): The ID of the user who submitted the ticket.  The submitter will is the author of the first comment on the ticket.
      • _assigneeid (text): The ID of the agent to whom the ticket is assigned.
      • _collaboratorids (text): A comma-delimited list of the IDs of the users who are currently CC’d on the ticket.
      • _organizationid (text): The ID of the organization of that the requester belongs to.
      • _groupid (text): The ID of the group the user is assigned to.
      • forum_topic_id (text): The ID of the forum topic that the ticket originated from, if any.
      • _problemid (text): The ID of the problem that the ticket (if incident) is linked to, if any.
      • _hasincidents (text): Returns ‘true’ if the ticket type is ‘problem’.  Returns ‘false’ otherwise.
      • _due_a_t (text): The due date of the ticket if it is of type ‘task’.
      • _tags_ (text): A comma-delimited list of the tags associated with the ticket.
      • _via_ (text): A description of how the ticket was created (ex: “api”, “web”, “mobile”).
      • _satisfaction_rating_ (text):  The satisfaction rating of the ticket, or the state of satisfaction (“offered” or “unoffered”).
      • sharing_agreement_ids (List): A list of numbers of the sharing agreement IDs used for this ticket.
      • _followup_ids_ (List): A list of numbers of the follow up ticket IDs used for this ticket.
      • _ticket_form_id_ (text): The ID of the brand associated with this ticket.
      • _brand_id_ (text): The ID of the brand associated with this ticket.
      • public? (True/False): True or false about whether the ticket is publicly viewed or not.
      • _createdat (text): Date and time that the ticket was created (ex: 2016-05-24T13:41:22Z).
      • _updatedat (text): Date and time that the ticket was most recently updated.

  • Updated Ticket WebHook

    This card monitors for tickets that are updated within Zendesk.

    Output Fields

    Any custom fields that exist will appear under ‘Record’.

    • Record
      • id (text): The ID of the ticket.
      • url (text): The URL of the ticket.
      • external id (text): An ID that you can assign to match this ticket with your own records.
      • type (text): The type of ticket.  Can be “problem”, “incident”, “question” or “task”.
      • subject (text): The subject of the ticket.
      • description (text): The first comment on a ticket.
      • priority (text): The priority of the ticket. Can be “urgent”, “high”, “normal”, or “low”.
      • status (text): The state of the ticket.  Can be “new”, “open”, “pending”, “hold”, “solved”, or “closed”.
      • recipient (text): The email address of the original recipient of the ticket.
      • requested id (text): The ID of the user who requested the ticket.
      • submitter id (text): The ID of the user who submitted the ticket.  The submitter will is the author of the first comment on the ticket.
      • assignee id (text): The ID of the agent to whom the ticket is assigned.
      • collaborator ids (text): A comma-delimited list of the IDs of the users who are currently CC’d on the ticket.
      • organization id (text): The ID of the organization of that the requester belongs to.
      • group id (text): The ID of the group the user is assigned to.
      • forum topic id (text): The ID of the forum topic that the ticket originated from, if any.
      • problem id (text): The ID of the problem that the ticket (if incident) is linked to, if any.
      • has incidents (text): Returns ‘true’ if the ticket type is ‘problem’.  Returns ‘false’ otherwise.
      • due at (text): The due date of the ticket if it is of type ‘task’.
      • tags (text): A comma-delimited list of the tags associated with the ticket.
      • via (text): A description of how the ticket was created (ex: “api”, “web”, “mobile”).
      • satisfactionrating** (text):  The satisfaction rating of the ticket, or the state of satisfaction (“offered” or “unoffered”).
      • sharing agreement ids (List): A list of numbers of the sharing agreement IDs used for this ticket.
      • followupids** (List): A list of numbers of the follow up ticket IDs used for this ticket.
      • ticket form id (text): The ID of the brand associated with this ticket.
      • brand id (text): The ID of the brand associated with this ticket.
      • public? (True/False): True or false about whether the ticket is publicly viewed or not.
      • created at (text): Date and time that the ticket was created (ex: 2016-05-24T13:41:22Z).
      • updated at (text): Date and time that the ticket was most recently updated.

Actions

  • Add User to Organization

    Add User to Organization

    Add user to organization within Zendesk.

    Input Fields

    • Entity
      • Organization ID (number): Unique Identification number of the organization the user will be added to. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/organizations/< Organization ID >.
      • User ID (number): Unique Identification number of the user. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/users/< User ID >.

    Output Fields

    • Membership
      • Membership ID (number): Identification of new membership.
      • Created At (text): Date and time user was added to organization.

  • Comment on Ticket

    Comment on Ticket

    Comment on searched ticket.

    Input Fields

    • Ticket
      • Ticket ID (number): Unique Identification number of the ticket that comment will be added to. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/tickets/< ticket ID >.
    • Membership
      • Body (text): Body of message/comment on ticket.
      • Public? (yes or no): True indicates comment is public to all viewers of ticket.

    Output Fields

    • There are no output fields.

  • Create Organization

    Create Organization

    Create a new organization on Zendesk.

    Input Fields

    • Organization
      • External ID (text): A unique id you can specify for the user.
      • Name (text): Name of user searched.
      • Domain Names (list): Drop down menu of possible domain names to associate with organization.
      • Details (text): Any details you want to store about the user, such as an address.
      • Notes (text): Any notes you want to store about the user.
      • Group ID (number): Identification number of group organization is associated with.
      • Shared Tickets? (yes or no): If true is marked, tickets are not shared.
      • Shared Comments (yes or no):true if the comments within organization are shared.
      • Tags (list): Drop down menu of tags related to organization.

    Output Fields

    • Membership
      • Organization ID (number): Identification code of organization user is associated with.

  • Create Ticket

    Create new ticket.

    Input Fields

    • Ticket
      • Subject (text): The value of the subject field for this ticket.
      • Description (text): The first comment on the ticket (header for ticket).
      • Type (text): The type of this ticket, i.e. “problem”, “incident”, “question”, or “task”.
      • External ID (text): A unique id you can use to link Zendesk Support tickets to local records.
      • Priority (text): Priority defines the urgency with which the ticket should be addressed, “urgent”, “high”, “normal”, and “low”.
      • Status (text): The state of the ticket , “new, “open”, “pending”, “hold”, “solved”, or “closed”.
      • Recipient (text): The original recipient e-mail address of the ticket.
      • Requester ID (number): Identification code of  user who requested this ticket.
      • Submitter ID (number): Identification code of the user who submitted the ticket; The submitter always becomes the author of the first comment on the ticket.
      • Assignee ID (number): Identification code of what agent is currently assigned to the ticket.
      • Group ID (number): Identification number of the group this ticket is assigned to.
      • Forum Topic ID (number): The topic this ticket originated from, if any.
      • Problem ID(number): Identification code of the problem this incident is linked to, if any.
      • Due At (date): If this is a ticket of type “task” it has a due date. Due date format uses ISO 8601 format.
      • Ticket Form ID (number): The Id of the ticket form to render for this ticket - only applicable for enterprise accounts.
      • Brand ID (number): The Id of the brand this ticket is associated with - only applicable for enterprise accounts.
      • Tags (list): The array of tags applied to this ticket.

    Output Fields

    *   **Ticket ID** (_number_): Identification code of new ticket.

  • Create User

    This card will create a new user.

    Input Fields

    • User
      • Name (text): Name of user.
      • External ID (text): A unique id you can specify for the user.
      • Alias (text): An alias displayed to end users.
      • Verified (true/false): If the user’s identity has been verified or not.
      • Local ID (number): The user’s language identifier.
      • Timezone (text): The user’s time zone. See Time Zone..
      • Email (text): The user’s primary email address.
      • Phone (text): The user’s primary phone number.
      • Details (text): Any details you want to store about the user, such as an address.
      • Notes (text): Any notes you want to store about the user.
      • Organization ID (number): Identification code of organization user is associated with.
      • Role (text): The user’s role. Possible values are end-user, agent, or admin.
      • Custom Role ID (text): A custom role if the user is an agent on the Enterprise plan.
      • Moderator? (yes or no): Designates whether the user has forum moderation capabilities.
      • Ticket Restriction (text): Specifies which tickets the user has access to. Possible values are: organization, groups, assigned, requested, null.
      • Private Comments Only? (true/false): true if the user can only create private comments.
      • Restricted Agent? (true/false): If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.
      • Tags (text): The user’s tags. Only present is your account has user tagging available.

    Output Fields

    • User ID (number): Unique ID of the user created.

  • Download Attachment

    Download uploaded attachment to ZendeskOAuth.

    Input Fields

    • Downloaded by
      • Attachment ID (number): Identification code of new ticket.

    Output Fields

    • File Content (upload): Image file indicated to be uploaded.
    • Name (text): Name of image file.
    • Size (text): Size of file (Eg. #MB, GB).
    • URL (text): A full URL where the attachment image file can be downloaded.

  • HTTP Request

    Make an authenticated HTTP request to the Zendesk API

  • Read Organization

    Read an organization from Zendesk.

    Input Fields

    • Read by
      • Organization ID (number): Unique Identification number of the organization that will be read by this card. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/organizations/< Organization ID >.
      • External ID (text): A unique id you can specify for the user.

    Output Fields

    • Organization
      • Organization ID (number): Identification code of organization user is associated with.
      • Organization URL (text): Website URL of organization.
      • External ID (text): A unique id you can specify for the user.
      • Name (text): Name of user searched.
      • Created At (date): Time and date organization was created.
      • Updated At (date): Time and date organization was last updated.
      • Domain Names (list): Drop down menu of possible domain names to associate with organization.
      • Details (text): Any details you want to store about the user, such as an address.
      • Notes (text): Any notes you want to store about the user.
      • Group ID (number): Identification number of group organization is associated with.
      • Shared Tickets? (yes or no): If true is marked, tickets are not shared.
      • Shared Comments (yes or no):true if the comments within organization are shared.
      • Tags (list): Drop down menu of tags related to organization.

  • Read Organization Tickets

  • readOrganizationUsers

    Read list of users a part of organization.

    Input Fields

    • Get by
      • Organization ID (text): Unique Identification number of the organization. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/organizations/< Organization ID >.

    Output Fields

    • Users (list): List of users associated with organization.

  • Read Ticket

    Read ticket from Zendesk.

    Input Fields

    • Read By
      • Ticket ID (number): Unique Identification number of the ticket that will be read by this card. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/tickets/< ticket ID >.

    Output Fields

    • Ticket
      • Ticket URL (text): The website URL the ticket is associated with.
      • External ID (text): A unique id you can use to link Zendesk Support tickets to local records.
      • Created At (date): Time and date organization was created.
      • Updated At (date): Time and date organization was last updated.
      • Type (text): The type of this ticket, i.e. “problem”, “incident”, “question”, or “task”.
      • Subject (text): The value of the subject field for this ticket.
      • Description* (text): The first comment on the ticket (header for ticket).
      • Priority (text): Priority defines the urgency with which the ticket should be addressed, “urgent”, “high”, “normal”, and “low”.
      • Status (text): The state of the ticket , “new, “open”, “pending”, “hold”, “solved”, or “closed”.
      • Recipient (text): The original recipient e-mail address of the ticket.
      • Requester ID (number): Identification code of  user who requested this ticket.
      • Submitter ID (number): Identification code of the user who submitted the ticket; The submitter always becomes the author of the first comment on the ticket.
      • Assignee ID (number): Identification code of what agent is currently assigned to the ticket.
      • Collaborator ID (number): Identification code of who is currently CC’ed on the ticket
      • Group ID (number): Identification number of the group this ticket is assigned to.
      • Forum Topic ID (number): The topic this ticket originated from, if any.
      • Problem ID(number): Identification code of the problem this incident is linked to, if any.
      • Has Incidents? (yes or no): Is true of this ticket has been marked as a problem, false otherwise.
      • Due At (date): If this is a ticket of type “task” it has a due date. Due date format uses ISO 8601 format.
      • Tags (list): The array of tags applied to this ticket.
      • Via Channel (text): This object explains how the ticket was created using channels.
      • Satisfaction Score (text): The rating: “offered”, “unoffered”, “good” or “bad”.
      • Satisfaction Comment (text): The comment received with this rating, if available
      • Sharing Agreement IDs (list): The ids of the sharing agreements used for this ticket.
      • Ticket Form ID (number): The Id of the ticket form to render for this ticket - only applicable for enterprise accounts.
      • Brand ID (number): The Id of the brand this ticket is associated with - only applicable for enterprise accounts.

  • Read Ticket Attachments

    Enter a ticket ID and return an array of attachments.

    Input Fields

    • Ticket
      • Ticket ID (number): Unique Identification number of the ticket that will be read. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/tickets/< ticket ID >.

    Output Fields

    • Attachments (list): Array of attached information to specified ticket. (Eg. File Name, Content URL, Size, etc…).

  • Read User

    Read searched user.

    Input Fields

    • Read By
      • User ID (number): Unique Identification number of the user that will be read. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/users/< User ID >.

    Output Fields

    • User
      • User URL (text): Website URL of user profile.
      • Name (text): Name of user searched.
      • External ID (text): A unique id you can specify for the user.
      • Alias (text): An alias displayed to end users.
      • Created At (date): Time and date organization was created.
      • Updated At (date): Time and date organization was last updated.
      • Active? (yes or no): If yes, the user is active.
      • Verified (yes or no): If the user’s identity has been verified or not.
      • Local ID (number): The user’s language identifier.
      • Timezone (text): The user’s time zone. See Time Zone.
      • Email (text): The user’s primary email address.
      • Phone (text): The user’s primary phone number.
      • Details (text): Any details you want to store about the user, such as an address.
      • Notes (text): Any notes you want to store about the user.
      • Organization ID (number): Identification code of organization user is associated with.
      • Role (text): The user’s role. Possible values are "end-user", "agent", or "admin".
      • Custom Role ID (text): A custom role if the user is an agent on the Enterprise plan.
      • Moderator? (yes or no): Designates whether the user has forum moderation capabilities.
      • Ticket Restriction (text): Specifies which tickets the user has access to. Possible values are: "organization", "groups", "assigned", "requested", null.
      • Private Comments Only? (yes or no):true if the user can only create private comments.
      • Tags (text): The user’s tags. Only present is your account has user tagging available.
      • Restricted Agent? (yes or no): If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.
      • Suspended (yes or no): If “true”, user is suspended.

  • Remove User from Organization

    This action enables you to remove a user from a specific organization within Zendesk. The key requirement is that you are able to find and locate the specific user’s membership ID for that organization.

    Input Fields

    • Entity
      • Membership ID (number): This is a unique identifier that each user has within each specific organization.

    NOTE: This identifier needs to be the specific users membership ID associated with the specific organization that they are intended to be removed from. Often it will require going through the list of all users within an organization in order to get their membership ID, which you then can use to remove the user.

  • searchOrganization

    Search for organization from Zendesk.

    Input Fields

    • Organization
      • Name (text): Name of user searched.
      • Details (text): Any details you want to store about the user, such as an address.
      • Notes (text): Any notes you want to store about the user.
      • Tags (list): Drop down menu of tags related to organization.

    Output Fields

    • There are no output fields.

  • Search Tickets

    Search for one or more tickets and return the ticket ID(s). The ticket ID can be used with another other card to read the ticket, update its information, and more.

    Options

    • Return
      • Single ticket: if selected, this card will return the first ticket matching your search. Use this option when you are looking for a specific ticket.
      • All matching tickets: if selected, this card will return a collection of tickets matching your search. Use this option when you are looking for a filtered set of tickets.

    Input Fields

    Use one or more of the input fields to search for tickets.  The fields are searched cumulatively, meaning that if you provide search values for two fields, the card will only return ticket(s) that match both of those fields. Any results that you do not want to search by should be hidden from the card.

    • Ticket
      • Subject (text): The subject of the ticket.
      • Description (text): The description (or the first comment) on a ticket.
      • Type (option): The type of ticket.  Can be ”problem”, “incident”, “question” or “task”.
      • Priority (option): The priority of the ticket. Can be ”urgent”, “high”, “normal”, or “low”.
      • Status (text): The state of the ticket.  Can be ”new”, “open”, “pending”, “hold”, “solved”, or “closed”.
      • Requester (number): The ID of the user who requested the ticket.
      • Assignee (text): The ID of the agent to whom the ticket is assigned.
      • Organization (text): The ID of the organization of that the requester belongs to.
      • Group (text): The ID of the group the ticket is assigned to.
      • Due Date (text): The due date of the ticket if it is of type ‘task’. Must be in ISO 8601 format.
      • Tags (list of text): A list of the tags associated with the ticket. Ticket must have each of the tags in this list to be included in the search results.
      • Via Channel (option): The service channel where the ticket was created (ex: “api”, “web”, “mobile”).
      • Ticket Form (text): The ID of the ticket form that was used to render this ticket, if any.
      • Brand (text): The ID of the brand associated with this ticket.
      • Has Attachment? (boolean): If ‘True’ is selected, only tickets with attachments will be included in the results. If ‘False’ only tickets without attachments will be included in the results.
      • Attachment Name (text): The filename of any attachment.
      • CC (text): ID of any user who is currently CC’d on the ticket.
      • Custom Field Value (text): Searches each custom field on the ticket for a matching value.

    Output Fields

    If you selected “Single ticket” in the options step, the outputs will look like this:

    • Result
      • Ticket ID (text): The ID of the fist ticket returned by the search.

    If you selected “All matching tickets” in the options step, the outputs will look like this:

    • Result
      • Ticket IDs (collection of strings): The IDs of all tickets returned by the search.

  • Search Users

    Search for user.

    Input Fields

    • User
      • Name (text): Name of user searched.
      • External ID (text): A unique id you can specify for the user.
      • Email (text): The user’s primary email address.
      • Phone (text): The user’s primary phone number.
      • Group (text): Name of group user is associated with.
      • Details (text): Any details you want to store about the user, such as an address.
      • Notes (text): Any notes you want to store about the user.
      • Organization (text): Name of organization user is associated with
      • Role (text): The user’s role. Possible values are "end-user", "agent", or "admin".
      • Tags (text): The user’s tags. Only present is your account has user tagging available.

    Output Fields

    • There are no output fields.

  • Suspend User

    Suspend User from Zendesk.

    Input Fields

    • User
      • User ID (number): Unique Identification number of the user that will be suspended by this card. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/users/< User ID >.

    Output Fields

    • There are no output fields.

  • Update Organization

    This card update an existing organization.

    Input Fields

    • Update by
      • Organization ID (number): Unique Identification number of the organization that will be updated by this card. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/organizations/< Organization ID >.
    • Organization
      • External ID (text): A unique id you can specify for the user.
      • Name (text): Name of user searched.
      • Domain Names (list): Drop down menu of possible domain names to associate with organization.
      • Details (text): Any details you want to store about the user, such as an address.
      • Notes (text): Any notes you want to store about the user.
      • Group ID (number): Identification number of group organization is associated with.
      • Shared Tickets? (yes or no): If true is marked, tickets are not shared.
      • Shared Comments (yes or no):true if the comments within organization are shared.
      • Tags (list): Drop down menu of tags related to organization.

    Output Fields

    • There are no output fields.

  • Update Ticket

    Update previously created ticket.

    Input Fields

    • Update by
      • Ticket ID (number): Unique Identification number of the ticket that will be updated by this card. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/tickets/< ticket ID >.

    • Ticket

      • Subject (text): The value of the subject field for this ticket.
      • Type (text): The type of this ticket, i.e. problem, incident, question, or task.
      • External ID (text): A unique id you can use to link Zendesk Support tickets to local records.
      • Priority (text): Priority defines the urgency with which the ticket should be addressed, urgent, high, normal, and low.
      • Status (text): The state of the ticket, e.g. new, open, pending, hold, solved, or closed.
      • Recipient (text): The original recipient e-mail address of the ticket.
      • Requester ID (number): Identification code of user who requested this ticket.
      • Submitter ID (number): Identification code of the user who submitted the ticket; The submitter always becomes the author of the first comment on the ticket.
      • Assignee ID (number): Identification code of what agent is currently assigned to the ticket.
      • Group ID (number): Identification number of the group this ticket is assigned to.
      • Forum Topic ID (number): The topic this ticket originated from, if any.
      • Problem ID(number): Identification code of the problem this incident is linked to, if any.
      • Due At (date): If this is a ticket of type “task” it has a due date. Due date format uses ISO 8601 format.
      • Ticket Form ID (number): The Id of the ticket form to render for this ticket - only applicable for enterprise accounts.
      • Brand ID (number): The Id of the brand this ticket is associated with - only applicable for enterprise accounts.
      • Tags (list): The array of tags applied to this ticket.

    • Output Fields

      • There are no output fields.

  • Update User

    Update user about change in information.

    Input Fields

    • Update by
      • User ID (number): Unique Identification number of the user that will be updated by this card. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/users/< User ID >.

    Output Fields

    • User
      • Name (text): Name of user searched.
      • External ID (text): A unique id you can specify for the user.
      • Organization ID (number): Identification code of organization user is associated with.
      • Alias (text): An alias displayed to end users.
      • Verified (yes or no): If the user’s identity has been verified or not.
      • Local ID (number): The user’s language identifier.
      • Timezone (text): The user’s time zone. See Time Zone.
      • Email (text): The user’s primary email address.
      • Phone (text): The user’s primary phone number.
      • Details (text): Any details you want to store about the user, such as an address.
      • Notes (text): Any notes you want to store about the user.
      • Role (text): The user’s role. Possible values are "end-user", "agent", or "admin".
      • Custom Role ID (text): A custom role if the user is an agent on the Enterprise plan.
      • Moderator? (yes or no): Designates whether the user has forum moderation capabilities.
      • Ticket Restriction (text): Specifies which tickets the user has access to. Possible values are: "organization", "groups", "assigned", "requested", null.
      • Private Comments Only? (yes or no):true if the user can only create private comments.
      • Restricted Agent? (yes or no): If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.
    • Output Fields
      • There are no output fields.

  • Upload Attachment

    Upload a file and attach it to a ticket

    Input Fields

    • Attach To
      • Ticket ID (number) : Unique Identification number of the ticket that will be attached an attachment by this card. The ID could be found in the URL of the document in this format : http://< your domain>.zendesk.com/agent/tickets/< ticket ID >.
      • Comment (text) : The comment received with this file, if available.
      • Public? (true/false) : True indicates the file is public to all viewers of ticket.
    • File
      • File Name (text) : The file text name.
      • File Content (file) : The file itself.

    Output Fields

    • Attachment ID (number) : The identification of the attachment.
    • Attachment URL (text) : The url of the attachment.
    • Ticket URL (text) : The ticket of the ticket that attachment attached to.