| Namespace | http://www.mulesoft.org/schema/mule/zendesk |
| Schema Location | http://www.mulesoft.org/schema/mule/zendesk/current/mule-zendesk.xsd (View Schema) |
| Schema Version | 1.0 |
| Minimum Mule Version | 3.4 |
Module Overview
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.
Configuration
To use the this module within a flow the namespace to the module must be included. The resulting flow will look
similar to the following:
<mule xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:zendesk="http://www.mulesoft.org/schema/mule/zendesk"
xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/zendesk
http://www.mulesoft.org/schema/mule/zendesk/current/mule-zendesk.xsd">
<!-- here goes your flows and configuration elements -->
</mule>
This module is configured using the config element. This element must be placed outside of your flows and at
the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries
its own name.
Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to
specify which configuration to use.
| Attributes |
| Type | Name | Default Value | Description | Java Type | MIME Type | Encoding |
xs:string |
name |
|
Optional. Give a name to this configuration so it can be later referenced. |
| | |
|
xs:string |
apiUrl |
|
Zendesk API endpoint. |
|
|
|
Connection Pool
This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of
this connector.
Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will
create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.
The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:
<zendesk:connection-pooling-profile maxActive="10" maxIdle="10"
exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>
The following is a list of connection attributes, each connection attribute can be configured at the config element level or
they can also be added to each processor. If they are used at the processor level they get the benefit of full expression
resolution.
| Connection Attributes |
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. | | | |
| username |
|
Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Zendesk password |
String |
*/* |
UTF-8 |
Reconnection Strategies
Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:
- The type of exception
- Number and frequency of reconnection attempts
- The notifications generated, and more
With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example,
to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic
notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that
attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for
nightly maintenance.
Configuration
A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.
<zendesk:config>
<reconnect count="5" frequency="1000"/>
</zendesk:config>
| Reconnect Attributes |
| Name | Default Value | Description |
| frequency |
2000 |
Optional. How often (in ms) to reconnect |
| count |
2 |
Optional. How many reconnection attempts to make |
For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.
Message Processors
<zendesk:apply-macro>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| macroId |
|
Macro to be applied
|
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:apply-macro-to-ticket>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| macroId |
|
Macro to be applied |
Long |
*/* |
|
| ticketId |
|
Ticket to apply the macro
|
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:bulk-import-ticket>
It allows moving data from legacy systems into Zendesk. Zendesk does not run triggers or the likes during bulk imports like these.
Check Zendesk API documentation
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticket |
#[payload] |
Optional. Ticket to be created |
Ticket |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Ticket |
ticket created
|
<zendesk:check-for-vote>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicId |
|
Topic id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:create-automation>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| automation |
#[payload] |
Optional. Automation to be created |
Automation |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Automation |
created automation info
|
<zendesk:create-category>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| category |
#[payload] |
Optional. Category to be created |
Category |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Category |
new user information
|
<zendesk:create-forum>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| forum |
#[payload] |
Optional. Forum to be created |
Forum |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Forum |
created forum
|
<zendesk:create-forum-subscription>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| forumSubscription |
#[payload] |
Optional. Forum subscription to be created |
ForumSubscription |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:create-group>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| group |
#[payload] |
Optional. Group to be created |
Group |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Group |
Created group
|
<zendesk:create-group-membership>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| groupMembership |
#[payload] |
Optional. Group membership to be created |
GroupMembership |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:create-macro>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| macro |
#[payload] |
Optional. Macro to be created |
Macro |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Macro |
new macro info
|
<zendesk:create-organization>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| organization |
#[payload] |
Optional. Organization to be created |
Organization |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:create-request>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| request |
#[payload] |
Optional. Request to be created |
Request |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Request |
new request information
|
<zendesk:create-satisfaction-rating>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| satisfactionRating |
#[payload] |
Optional. Satisfaction rating to be created |
SatisfactionRating |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:create-ticket>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticket |
#[payload] |
Optional. Ticket to create |
Ticket |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Ticket |
new Ticket
|
<zendesk:create-ticket-field>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticketField |
#[payload] |
Optional. Ticket Field object to create |
TicketField |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:create-topic>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topic |
#[payload] |
Optional. Topic to be created |
Topic |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Topic |
new topic
|
<zendesk:create-topic-comment>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicComment |
#[payload] |
Optional. Topic comment to be created |
TopicComment |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:create-topic-subscription>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicSubscription |
#[payload] |
Optional. Topic subscription to be created |
TopicSubscription |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:create-topic-vote>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicVote |
#[payload] |
Optional. Topic vote to be created |
TopicVote |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| TopicVote |
created topic vote
|
<zendesk:create-trigger>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| trigger |
#[payload] |
Optional. Trigger to be created |
Trigger |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Trigger |
new trigger
|
<zendesk:create-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| user |
#[payload] |
Optional. To be created |
User |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| User |
new user information
|
<zendesk:create-user-identity>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userIdentity |
#[payload] |
Optional. User identity to be created |
UserIdentity |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| UserIdentity |
user identity information
|
<zendesk:create-view>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| view |
#[payload] |
Optional. View to be created |
View |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| View |
new view
|
<zendesk:delete-attachment>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| attachmentId |
|
Attachment id
|
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-category>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| category |
#[payload] |
Optional. Category to be deleted
|
Category |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-forum>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| forum |
#[payload] |
Optional. Forum to be deleted
|
Forum |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-forum-subscription>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| forumSubscription |
#[payload] |
Optional. Forum subscription to be deleted
|
ForumSubscription |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-group>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| group |
#[payload] |
Optional. Group to be deleted
|
Group |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-group-membership>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| groupMembership |
#[payload] |
Optional. Group membership to be deleted
|
GroupMembership |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-macro>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| macro |
#[payload] |
Optional. Macro to be deleted
|
Macro |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-organization>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| organization |
#[payload] |
Optional. Organization to be updated
|
Organization |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-suspended-ticket>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| suspendedTicketId |
|
Suspended ticket id
|
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-ticket>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticket |
#[payload] |
Optional. Ticket to delete |
Ticket |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Ticket |
deleted ticket
|
<zendesk:delete-topic>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topic |
#[payload] |
Optional. Topic to be deleted
|
Topic |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-topic-comment>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicComment |
#[payload] |
Optional. Topic comment to be deleted
|
TopicComment |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-topic-subscription>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicSubscription |
#[payload] |
Optional. Topic subscription to be deleted
|
TopicSubscription |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-topic-vote>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicVote |
#[payload] |
Optional. Topic vote to be deleted
|
TopicVote |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-upload>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| token |
|
Token for the attachment
|
String |
*/* |
UTF-8 |
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:delete-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| user |
#[payload] |
Optional. To be deleted |
User |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| User |
deleted user information
|
<zendesk:delete-user-identity>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userIdentity |
#[payload] |
Optional. User identity to be deleted |
UserIdentity |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| UserIdentity |
user identity information
|
<zendesk:execute-view>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| viewId |
|
View id to be executed |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| ViewExecute |
view execution response
|
<zendesk:get-activity>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| activityId |
|
Activity id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:get-attachment>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| attachmentId |
|
Attachment id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Attachment |
attachment information
|
<zendesk:get-automation>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| automationId |
|
Automation id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Automation |
automation info
|
<zendesk:get-category>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| categoryId |
|
Category id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Category |
category information
|
<zendesk:get-current-locale>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Locale |
current locale information
|
<zendesk:get-current-user>
Returns current user information
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| User |
current user
|
<zendesk:get-forum>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| forumId |
|
Forum id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Forum |
list of forums
|
<zendesk:get-forum-subscription>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| forumSubscriptionId |
|
Forum id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:get-group>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| groupId |
|
Group id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Group |
group information
|
<zendesk:get-group-membership>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| groupMembershipId |
|
Group membership id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:get-group-membership-by-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| groupMembershipId |
|
Group membership |
Long |
*/* |
|
| userId |
|
User |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:get-locale>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| localeId |
|
Locale id |
Integer |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Locale |
locale information
|
<zendesk:get-macro>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| macroId |
|
Macro id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Macro |
macros information
|
<zendesk:get-organization>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| organizationId |
|
Organization id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Organization |
organization information
|
<zendesk:get-organization-related>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| organizationId |
|
Organization id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:get-request>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| requestId |
|
Request id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Request |
list of requests
|
<zendesk:get-request-comment>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| requestId |
|
Request id |
Long |
*/* |
|
| commentId |
|
CommentId |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| TicketComment |
request comment information
|
<zendesk:get-satisfaction-rating>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| satisfactionRatingId |
|
Satisfaction rating id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:get-suspended-ticket>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| suspendedTicketId |
|
Suspended ticket id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:get-ticket>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticketId |
|
Ticket id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Ticket |
ticket information
|
<zendesk:get-ticket-audit>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticketId |
|
Ticket id |
Long |
*/* |
|
| auditId |
|
Audit id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| TicketAudit |
ticket audit information
|
<zendesk:get-ticket-metrics>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticketId |
|
Ticket to get metrics |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:get-tickets-from-view>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| viewId |
|
View to get tickets from |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Ticket> |
list of tickets
|
<zendesk:get-topic>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicId |
|
Topic id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Topic |
topic info
|
<zendesk:get-topic-comment>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicId |
|
Topic id |
Long |
*/* |
|
| topicCommentId |
|
Topic comment id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| TopicComment |
topic comment information
|
<zendesk:get-topic-subscription>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicSubscriptionId |
|
Topic comment id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:get-trigger>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| triggerId |
|
Trigger id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Trigger |
trigger information
|
<zendesk:get-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userId |
|
To get retrieved |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| User |
user information
|
<zendesk:get-user-identity>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userId |
|
User id |
Long |
*/* |
|
| userIdentityId |
|
User identity id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| UserIdentity |
user identity information
|
<zendesk:get-user-related>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userId |
|
To get information |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| UserRelated |
user related information
|
<zendesk:get-view>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| viewId |
|
View information to be retrieved |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| View |
view information
|
<zendesk:get-view-counts>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Child Elements
| Name | Default Value | Description | Java Type |
|---|
| <zendesk:view-ids> |
|
List of view ids |
List<String> |
Returns
| Return Type |
Description |
| ViewExecute |
view count response
|
<zendesk:import-topic>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topic |
#[payload] |
Optional. Topic to be created |
Topic |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Topic |
new topic
|
<zendesk:import-topic-comment>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicComment |
#[payload] |
Optional. Topic comment to be created |
TopicComment |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-active-automations>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Automation> |
list of active automations
|
<zendesk:list-active-macros>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Macro> |
active macros list
|
<zendesk:list-active-triggers>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Trigger> |
list of active triggers
|
<zendesk:list-active-views>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<View> |
active views
|
<zendesk:list-activities>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-assignable-groups>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Group> |
assignable groups
|
<zendesk:list-automations>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Automation> |
list of automations
|
<zendesk:list-categories>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Category> |
list of categories
|
<zendesk:list-compact-views>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<View> |
A compacted list of shared and personal views available to the current user
|
<zendesk:list-forum-subscriptions>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-forum-subscriptions-by-forum>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| forumId |
|
Forum id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-forums>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Forum> |
list of forums
|
<zendesk:list-forums-by-category>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| categoryId |
|
Category id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Forum> |
list of forums
|
<zendesk:list-group-assignable-memberships>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-group-assignable-memberships-by-group>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| groupId |
|
User id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-group-memberships>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-group-memberships-by-group>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| groupId |
|
User id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-group-memberships-by-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userId |
|
User id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-groups>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Group> |
available groups
|
<zendesk:list-locales>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Locale> |
locale list
|
<zendesk:list-macros>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Macro> |
macros list
|
<zendesk:list-organizations>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Organization> |
operation results
|
<zendesk:list-received-satisfaction-ratings>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-request-comments>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| requestId |
|
Request id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<TicketComment> |
list of comments for the given request
|
<zendesk:list-requests>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Request> |
list of requests
|
<zendesk:list-requests-by-status>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| status |
|
Request status. Available values are ccd, open, solved. |
String |
*/* |
UTF-8 |
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Request> |
list of requests
|
<zendesk:list-requests-by-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userId |
|
User id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Request> |
list of requests
|
<zendesk:list-satisfaction-ratings>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-sharing-agreements>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-suspended-tickets>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-ticket-audits>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticketId |
|
Ticket id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<TicketAudit> |
tickets audits list
|
<zendesk:list-ticket-fields>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<TicketField> |
tickets fields list
|
<zendesk:list-ticket-metrics>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<TicketMetric> |
ticket metrics list
|
<zendesk:list-tickets>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Ticket> |
list of tickets
|
<zendesk:list-topic-comments>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicId |
|
Topic id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<TopicComment> |
list of topic comments
|
<zendesk:list-topic-comments-by-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userId |
|
User id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<TopicComment> |
list of topic comments
|
<zendesk:list-topic-subscriptions>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-topic-subscriptions-by-topic>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicId |
|
Topic id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:list-topic-votes>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicId |
|
Topic id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<TopicVote> |
list of topic votes
|
<zendesk:list-topic-votes-by-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userId |
|
User id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<TopicVote> |
list of topic votes
|
<zendesk:list-topics>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Topic> |
list of topics
|
<zendesk:list-topics-by-forum>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| forumId |
|
Forum Id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Topic> |
list of topics
|
<zendesk:list-topics-by-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userId |
|
User Id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Topic> |
list of topics
|
<zendesk:list-triggers>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Trigger> |
list of triggers
|
<zendesk:list-user-identities>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userId |
|
User id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<UserIdentity> |
list of user identities
|
<zendesk:list-users>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<User> |
list of users
|
<zendesk:list-users-by-group>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| groupId |
|
Group id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<User> |
user information
|
<zendesk:list-users-by-organization>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| organizationId |
|
Organization id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<User> |
list of users
|
<zendesk:list-views>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<View> |
available views
|
<zendesk:make-user-identity-primary>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userIdentity |
#[payload] |
Optional. User identity to be set as primary |
UserIdentity |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| UserIdentity |
user identity information
|
<zendesk:recover-suspended-ticket>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| suspendedTicketId |
|
Suspended ticket id
|
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:request-user-identity-verification>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userIdentity |
#[payload] |
Optional. User identity |
UserIdentity |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| UserIdentity |
user identity information
|
<zendesk:search>
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
Check Zendesk API documentation
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| type |
|
Entity type. It has to be the same as the entity queried |
EntityType |
*/* |
|
| query |
|
String |
String |
*/* |
UTF-8 |
| sortBy |
|
Optional. Possible values are 'updated_at', 'created_at', 'priority', 'status', and 'ticket_type' |
String |
*/* |
UTF-8 |
| sortOrder |
|
Optional. One of 'relevance', 'asc', 'desc'. Defaults to 'relevance' when no 'order' criteria is requested. |
String |
*/* |
UTF-8 |
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Iterable |
updated trigger
|
<zendesk:search-organization>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| searchTerm |
|
Search term |
String |
*/* |
UTF-8 |
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Collection<Organization> |
list of organizations
|
<zendesk:set-group-membership-as-default>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| groupMembership |
#[payload] |
Optional. Group membership to be set as default |
GroupMembership |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:show-job-status>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| jobStatusId |
|
Job status id |
Long |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| JobStatus |
job status info
|
<zendesk:update-automation>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| automation |
#[payload] |
Optional. Automation to be updated |
Automation |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Automation |
updated automation info
|
<zendesk:update-category>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| category |
#[payload] |
Optional. Category to be updated |
Category |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Category |
updated category information
|
<zendesk:update-forum>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| forum |
#[payload] |
Optional. Forum to be updated |
Forum |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Forum |
updated forum
|
<zendesk:update-group>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| group |
#[payload] |
Optional. Group to be update |
Group |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Group |
Updated group
|
<zendesk:update-macro>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| macro |
#[payload] |
Optional. Macro to be updated |
Macro |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Macro |
updated macro info
|
<zendesk:update-organization>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| organization |
#[payload] |
Optional. Organization to be updated |
Organization |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:update-request>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| request |
#[payload] |
Optional. Request to be updated |
Request |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Request |
updated request information
|
<zendesk:update-ticket>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticket |
#[payload] |
Optional. Ticket to update |
Ticket |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Ticket |
updated ticket
|
<zendesk:update-ticket-field>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| ticketField |
#[payload] |
Optional. Ticket Field to be updated |
TicketField |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:update-topic>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topic |
#[payload] |
Optional. Topic to be updated |
Topic |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Topic |
update topic
|
<zendesk:update-topic-comment>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| topicComment |
#[payload] |
Optional. Topic comment to be updated |
TopicComment |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
<zendesk:update-trigger>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| trigger |
#[payload] |
Optional. Trigger to be updated |
Trigger |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| Trigger |
updated trigger
|
<zendesk:update-user>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| user |
#[payload] |
Optional. To be updated |
User |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| User |
updated user information
|
<zendesk:update-view>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| view |
#[payload] |
Optional. View to be updated |
View |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| View |
updated view
|
<zendesk:upload-attachment>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| content |
|
File to upload |
InputStream |
*/* |
|
| mediaType |
|
File media type. E.g.: application/octet-stream |
String |
*/* |
UTF-8 |
| filename |
|
Filename |
String |
*/* |
UTF-8 |
| token |
|
Optional. Optional token |
String |
*/* |
UTF-8 |
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| FileUpload |
upload information
|
<zendesk:verify-user-identity>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| userIdentity |
#[payload] |
Optional. User identity to be verified |
UserIdentity |
*/* |
|
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. |
| username |
|
Optional. Zendesk username |
String |
*/* |
UTF-8 |
| password |
|
Optional. Zendesk password |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| UserIdentity |
user identity information
|
Message Sources
Transformers