Mule Zendesk Cloud Connector
| java.lang.Object | |
| ↳ | org.mule.modules.zendesk.ZendeskConnector |
 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
Zendesk is a customer support platform that supports more than 25,000 businesses and 60 million customers in 140 countries around the globe. Many of these businesses use the Zendesk API to automate and enhance their customer support with Zendesk.
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| apiResource | |||||||||||
| apiUrl | Zendesk API endpoint. | ||||||||||
| client | Jersey client | ||||||||||
| jerseyUtil | |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Apply macro
| |||||||||||
Apply macro to an specific ticket
| |||||||||||
It allows moving data from legacy systems into Zendesk.
| |||||||||||
Check topic for vote
| |||||||||||
Connect to Zendesk
| |||||||||||
Are we connected
| |||||||||||
Create automation
| |||||||||||
Create category
| |||||||||||
Create Forum
| |||||||||||
Create forum subscription
| |||||||||||
Create group
| |||||||||||
Create membership
| |||||||||||
Create new macro
| |||||||||||
Create organization
| |||||||||||
Create request
| |||||||||||
Create satisfaction rating
| |||||||||||
Creates a new Zendesk ticket
| |||||||||||
Create a new ticket field
| |||||||||||
Create topic
| |||||||||||
Create Topic comment
| |||||||||||
Create Topic subscription
| |||||||||||
Create Topic vote
| |||||||||||
Create trigger
| |||||||||||
Create user
| |||||||||||
Create an user identity for a given user
| |||||||||||
Create new view
| |||||||||||
Delete attachment
| |||||||||||
Delete category
| |||||||||||
Delete Forum
| |||||||||||
Delete forum subscription
| |||||||||||
Delete group
| |||||||||||
Delete membership
| |||||||||||
Delete macro
| |||||||||||
Update organization
| |||||||||||
Delete a suspended ticket
| |||||||||||
Delete a ticket
| |||||||||||
Delete topic
| |||||||||||
Delete topic comment
| |||||||||||
Delete topic subscription
| |||||||||||
Delete topic vote
| |||||||||||
Delete upload
| |||||||||||
Delete user
| |||||||||||
Delete user identity
| |||||||||||
Disconnect
| |||||||||||
Execute a view
| |||||||||||
Get activity
| |||||||||||
Get attachment
| |||||||||||
Get automation
| |||||||||||
Get category
| |||||||||||
Get Current locale
| |||||||||||
Returns current user information
| |||||||||||
Get Forum
| |||||||||||
Get forum subscription
| |||||||||||
Get group for given group id
| |||||||||||
Get membership information
| |||||||||||
Get membership information
| |||||||||||
Get locale
| |||||||||||
Get macro
| |||||||||||
Get organization info
| |||||||||||
Get organization related information
| |||||||||||
Get request information
| |||||||||||
Get a particular comment for a given request
| |||||||||||
Get satisfaction rating info
| |||||||||||
Get suspended ticket
| |||||||||||
Get ticket
| |||||||||||
Get a ticket audit
| |||||||||||
Get ticket metric
| |||||||||||
Get tickets from view
| |||||||||||
Get topic
| |||||||||||
Get topic comment
| |||||||||||
Get topic subscription
| |||||||||||
Get trigger
| |||||||||||
Get user information
| |||||||||||
Get an user identity
| |||||||||||
Get user related information
| |||||||||||
Get a view information
| |||||||||||
Calculates the size of the view in terms of number of tickets the view will return
| |||||||||||
Creates a topic without sending out notifications.
| |||||||||||
Creates a comment without sending out notifications.
| |||||||||||
Are we connected
| |||||||||||
List active automations
| |||||||||||
List active macros
| |||||||||||
List active triggers
| |||||||||||
List active views
| |||||||||||
List activities
| |||||||||||
List assignable groups
| |||||||||||
List automations
| |||||||||||
List categories
| |||||||||||
List views
| |||||||||||
List forum subscriptions
| |||||||||||
List forum subscriptions by forum
| |||||||||||
List forums
| |||||||||||
List forums by category
| |||||||||||
List group memberships by group
| |||||||||||
List assignable memberships by group
| |||||||||||
List group memberships
| |||||||||||
List group memberships by group
| |||||||||||
List group memberships by user
| |||||||||||
List groups
| |||||||||||
List locales
| |||||||||||
List macros
| |||||||||||
List organizations
| |||||||||||
List received satisfaction ratings
| |||||||||||
List requests comments
| |||||||||||
List requests
| |||||||||||
List requests by status.
| |||||||||||
List requests by user
| |||||||||||
List satisfaction ratings
| |||||||||||
List sharing agreements
| |||||||||||
List suspended tickets
| |||||||||||
List Ticket audits for a given ticket
| |||||||||||
List Ticket audits for a given ticket
| |||||||||||
List ticket metrics
| |||||||||||
Get list of tickets
| |||||||||||
List topic comments
| |||||||||||
List topic comments by user
| |||||||||||
List topic subscriptions
| |||||||||||
List topic subscriptions by topic
| |||||||||||
List topic votes
| |||||||||||
List topic votes by user
| |||||||||||
List topics
| |||||||||||
List topics by forum
| |||||||||||
List topics by user
| |||||||||||
List triggers
| |||||||||||
Return all user identities for a given user id
| |||||||||||
Get users
| |||||||||||
Get users per group id
| |||||||||||
Get users per organization id
| |||||||||||
List views
| |||||||||||
Make user identity the primary
| |||||||||||
Recover a suspended ticket
| |||||||||||
Request user id verification
| |||||||||||
The search API is a unified search API that returns tickets, users, organizations, and forum topics.
| |||||||||||
Search organization
| |||||||||||
Set a group membership as default
| |||||||||||
Show Job Status
| |||||||||||
Update automation
| |||||||||||
Update category
| |||||||||||
Update Forum
| |||||||||||
Update group
| |||||||||||
Update macro
| |||||||||||
Update organization
| |||||||||||
Update request
| |||||||||||
Update a ticket
| |||||||||||
Update ticket field
| |||||||||||
Update topic
| |||||||||||
Update topic comment
| |||||||||||
Update trigger
| |||||||||||
Update user
| |||||||||||
Update a view
| |||||||||||
Upload File attachment
| |||||||||||
Verify user identity
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Zendesk API endpoint. E.g.: https://{subdomain}.zendesk.com/api/v2
Jersey client
Apply macro
| macroId | Macro to be applied |
|---|
Apply macro to an specific ticket
| macroId | Macro to be applied |
|---|---|
| ticketId | Ticket to apply the macro |
It allows moving data from legacy systems into Zendesk. Zendesk does not run triggers or the likes during bulk imports like these.
| ticket | Ticket to be created |
|---|
Check topic for vote
| topicId | Topic id |
|---|
Connect to Zendesk
| username | Zendesk username |
|---|---|
| password | Zendesk password |
| ConnectionException | when the service is unreachable or the credentials are not valid |
|---|
Are we connected
Create automation
| automation | Automation to be created |
|---|
Create category
| category | Category to be created |
|---|
Create Forum
| forum | Forum to be created |
|---|
Create forum subscription
| forumSubscription | Forum subscription to be created |
|---|
Create group
| group | Group to be created |
|---|
Create membership
| groupMembership | Group membership to be created |
|---|
Create new macro
| macro | Macro to be created |
|---|
Create organization
| organization | Organization to be created |
|---|
Create request
| request | Request to be created |
|---|
Create satisfaction rating
| satisfactionRating | Satisfaction rating to be created |
|---|
Creates a new Zendesk ticket
| ticket | Ticket to create |
|---|
Create a new ticket field
| ticketField | Ticket Field object to create |
|---|
Create Topic comment
| topicComment | Topic comment to be created |
|---|
Create Topic subscription
| topicSubscription | Topic subscription to be created |
|---|
Create Topic vote
| topicVote | Topic vote to be created |
|---|
Create trigger
| trigger | Trigger to be created |
|---|
Create user
| user | To be created |
|---|
Create an user identity for a given user
| userIdentity | User identity to be created |
|---|
Delete attachment
| attachmentId | Attachment id |
|---|
Delete category
| category | Category to be deleted |
|---|
Delete forum subscription
| forumSubscription | Forum subscription to be deleted |
|---|
Delete membership
| groupMembership | Group membership to be deleted |
|---|
Update organization
| organization | Organization to be updated |
|---|
Delete a suspended ticket
| suspendedTicketId | Suspended ticket id |
|---|
Delete a ticket
| ticket | Ticket to delete |
|---|
Delete topic comment
| topicComment | Topic comment to be deleted |
|---|
Delete topic subscription
| topicSubscription | Topic subscription to be deleted |
|---|
Delete topic vote
| topicVote | Topic vote to be deleted |
|---|
Delete upload
| token | Token for the attachment |
|---|
Delete user
| user | To be deleted |
|---|
Delete user identity
| userIdentity | User identity to be deleted |
|---|
Disconnect
Execute a view
| viewId | View id to be executed |
|---|
Get activity
| activityId | Activity id |
|---|
Get attachment
| attachmentId | Attachment id |
|---|
Get automation
| automationId | Automation id |
|---|
Get category
| categoryId | Category id |
|---|
Get forum subscription
| forumSubscriptionId | Forum id |
|---|
Get group for given group id
| groupId | Group id |
|---|
Get membership information
| groupMembershipId | Group membership id |
|---|
Get membership information
| groupMembershipId | Group membership |
|---|---|
| userId | User |
Get organization info
| organizationId | Organization id |
|---|
Get organization related information
| organizationId | Organization id |
|---|
Get request information
| requestId | Request id |
|---|
Get a particular comment for a given request
| requestId | Request id |
|---|---|
| commentId | CommentId |
Get satisfaction rating info
| satisfactionRatingId | Satisfaction rating id |
|---|
Get suspended ticket
| suspendedTicketId | Suspended ticket id |
|---|
Get a ticket audit
| ticketId | Ticket id |
|---|---|
| auditId | Audit id |
Get ticket metric
| ticketId | Ticket to get metrics |
|---|
Get tickets from view
| viewId | View to get tickets from |
|---|
Get topic comment
| topicId | Topic id |
|---|---|
| topicCommentId | Topic comment id |
Get topic subscription
| topicSubscriptionId | Topic comment id |
|---|
Get trigger
| triggerId | Trigger id |
|---|
Get user information
| userId | To get retrieved |
|---|
Get an user identity
| userId | User id |
|---|---|
| userIdentityId | User identity id |
Get user related information
| userId | To get information |
|---|
Get a view information
| viewId | View information to be retrieved |
|---|
Calculates the size of the view in terms of number of tickets the view will return
| viewIds | List of view ids |
|---|
Creates a topic without sending out notifications. Allows setting created_at and updated_at.
| topic | Topic to be created |
|---|
Creates a comment without sending out notifications. Allows setting created_at and updated_at.
| topicComment | Topic comment to be created |
|---|
Are we connected
List active automations
List active triggers
List views
List forum subscriptions
List forum subscriptions by forum
| forumId | Forum id |
|---|
List forums by category
| categoryId | Category id |
|---|
List group memberships by group
List assignable memberships by group
| groupId | User id |
|---|
List group memberships
List group memberships by group
| groupId | User id |
|---|
List group memberships by user
| userId | User id |
|---|
List received satisfaction ratings
List requests comments
| requestId | Request id |
|---|
List requests by status. Available values are ccd, open, solved.
| status | Request status. Available values are ccd, open, solved. |
|---|
List requests by user
| userId | User id |
|---|
List satisfaction ratings
List sharing agreements
List suspended tickets
List Ticket audits for a given ticket
| ticketId | Ticket id |
|---|
List Ticket audits for a given ticket
List ticket metrics
List topic comments
| topicId | Topic id |
|---|
List topic comments by user
| userId | User id |
|---|
List topic subscriptions
List topic subscriptions by topic
| topicId | Topic id |
|---|
List topic votes
| topicId | Topic id |
|---|
List topic votes by user
| userId | User id |
|---|
List topics by forum
| forumId | Forum Id |
|---|
List topics by user
| userId | User Id |
|---|
Return all user identities for a given user id
| userId | User id |
|---|
Get users per group id
| groupId | Group id |
|---|
Get users per organization id
| organizationId | Organization id |
|---|
Make user identity the primary
| userIdentity | User identity to be set as primary |
|---|
Recover a suspended ticket
| suspendedTicketId | Suspended ticket id |
|---|
Request user id verification
| userIdentity | User identity |
|---|
The search API is a unified search API that returns tickets, users, organizations, and forum topics. Define filters to narrow your search results according to result type, date attributes, and object attributes such as ticket requester or tag.
Important: This operation only returns one type of object at the time. If you query more than one type you'll get a ZendeskException
| type | Entity type. It has to be the same as the entity queried |
|---|---|
| query | String |
| sortBy | Possible values are 'updated_at', 'created_at', 'priority', 'status', and 'ticket_type' |
| sortOrder | One of 'relevance', 'asc', 'desc'. Defaults to 'relevance' when no 'order' criteria is requested. |
Search organization
| searchTerm | Search term |
|---|
| apiResource |
|---|
| apiUrl |
|---|
| client |
|---|
Set a group membership as default
| groupMembership | Group membership to be set as default |
|---|
| jerseyUtil |
|---|
Show Job Status
| jobStatusId | Job status id |
|---|
Update automation
| automation | Automation to be updated |
|---|
Update category
| category | Category to be updated |
|---|
Update Forum
| forum | Forum to be updated |
|---|
Update group
| group | Group to be update |
|---|
Update macro
| macro | Macro to be updated |
|---|
Update organization
| organization | Organization to be updated |
|---|
Update request
| request | Request to be updated |
|---|
Update a ticket
| ticket | Ticket to update |
|---|
Update ticket field
| ticketField | Ticket Field to be updated |
|---|
Update topic
| topic | Topic to be updated |
|---|
Update topic comment
| topicComment | Topic comment to be updated |
|---|
Update trigger
| trigger | Trigger to be updated |
|---|
Update user
| user | To be updated |
|---|
Update a view
| view | View to be updated |
|---|
Upload File attachment
| content | File to upload |
|---|---|
| mediaType | File media type. E.g.: application/octet-stream |
| filename | Filename |
| token | Optional token |
Verify user identity
| userIdentity | User identity to be verified |
|---|