Zendesk Connector 1.1 Reference | MuleSoft Documentation
# Zendesk Connector 1.1 Reference
## Configurations
### Config
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Name for this configuration. Connectors reference the configuration with this name.  
Connection | 
  * Api Token Connection Provider
  * Basic Authentication Connection Provider
  * Oauth2 Access Code Connection Provider

| The connection types to provide to this configuration.  
Response Timeout | The timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout field  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
The identifier of this element used to reference it in other components  
Expiration Policy |  Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.  
#### Connection Types
##### Api Token Connection Provider
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | The timeout for establishing connections to the remote service  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Connection Timeout  
Use Persistent Connections | If `false`, each connection will be closed after the first request is completed.  
Max Connections | The maximum number of outbound connections to keep open at the same time  
Connection Idle Timeout | A timeout for how long a connection can remain idle before it is closed  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the connection Idle Timeout  
Proxy Config | Reusable configuration element for outbound connections through a proxy  
Stream Response | Whether or not to stream received responses, which means that processing continues as soon as all headers are parsed and the body is streamed as it is received. When enabled, the response must eventually be read since, depending on the configured buffer size, the response might not fit into memory and processing stops until space is available.  
Response Buffer Size | The space, in bytes, for the buffer that stores the HTTP response.  
Base Uri | Parameter base URI. Each instance or tenant has its own base URI. | `https://{subdomain}.zendesk.com`  
Authorization | Authorization  
API version | API version to use.  
TLS Configuration  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
##### Basic Authentication Connection Provider
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | The timeout for establishing connections to the remote service  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Connection Timeout  
Use Persistent Connections | If `false`, each connection will be closed after the first request is completed.  
Max Connections | The maximum number of outbound connections to keep open at the same time  
Connection Idle Timeout | A timeout for how long a connection can remain idle before it is closed  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the connection Idle Timeout  
Proxy Config | Reusable configuration element for outbound connections through a proxy  
Stream Response | Whether or not to stream received responses, which means that processing continues as soon as all headers are parsed and the body is streamed as it is received. When enabled, the response must eventually be read since, depending on the configured buffer size, the response might not fit into memory and processing stops until space is available.  
Response Buffer Size | The space, in bytes, for the buffer that stores the HTTP response.  
Username | The username to authenticate the requests  
Password | The password to authenticate the requests  
Base Uri | Parameter base URI. Each instance or tenant has its own base URI. | `https://{subdomain}.zendesk.com`  
API version | API version to use.  
TLS Configuration  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
##### Oauth2 Access Code Connection Provider
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | The timeout for establishing connections to the remote service  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Connection Timeout  
Use Persistent Connections | If `false`, each connection will be closed after the first request is completed.  
Max Connections | The maximum number of outbound connections to keep open at the same time  
Connection Idle Timeout | A timeout for how long a connection can remain idle before it is closed  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the connection Idle Timeout  
Proxy Config | Reusable configuration element for outbound connections through a proxy  
Stream Response | Whether or not to stream received responses, which means that processing continues as soon as all headers are parsed and the body is streamed as it is received. When enabled, the response must eventually be read since, depending on the configured buffer size, the response might not fit into memory and processing stops until space is available.  
Response Buffer Size | The space, in bytes, for the buffer that stores the HTTP response.  
Base Uri | Parameter base URI. Each instance or tenant has its own base URI. | `https://{subdomain}.zendesk.com`  
API version | API version to use.  
TLS Configuration  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
Consumer Key | The OAuth consumer key, as registered with the service provider  
Consumer Secret | The OAuth consumer secret, as registered with the service provider  
Authorization Url | The service provider’s authorization endpoint URL | `https://{subdomain}.zendesk.com/oauth/authorizations/new`  
Access Token Url | The service provider’s access token endpoint URL | `https://{subdomain}.zendesk.com/oauth/tokens`  
The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation | read write  
Resource Owner Id | The resource owner ID that each component should use if it isn’t otherwise referenced.  
The name of a flow to execute before starting the OAuth dance  
The name of a flow to execute right after an accessToken has been received  
Listener Config | A reference to an `<http:listener-config />` to use to create the listener that catches the access token callback endpoint.  
Callback Path | The path of the access token callback endpoint  
Authorize Path | The path of the local http endpoint that triggers the OAuth dance  
External Callback Url | If the callback endpoint is behind a proxy or should be accessed through an indirect URL, use this parameter to tell the OAuth provider the URL to use to access the callback  
Object Store | Reference to the object store used to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store.  
## Supported Operations
  * Upsert an organization
  * Create a ticket
  *   *   *   * 

## Associated Sources
  * New ticket created
  * New user created
  * Existing ticket updated
## Associated Sources
  * New ticket created
  * New user created
  * Existing ticket updated


## Upsert an organization
`<zendesk:create-organizations-create-or-updatejson>`
Creates an organization if it doesn’t already exist or updates an existing organization identified by an ID or an external ID. This operation makes an HTTP POST request to the /organizations/create_or_update.json endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
organizationToUpsert | Content to use. | #[payload]  
Config Ref |  ConfigurationProvider | Name of the configuration used to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | How long Mule waits for a response to complete before the request times out.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Response Timeout** field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| How the connector streams request content to the remote service: * `AUTO` (default) Connector automatically uses the best streaming strategy based on the request content. * `ALWAYS` Connector always streams the request content. * `NEVER` Connector does not stream the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * ZENDESK:BAD_REQUEST
  * ZENDESK:CLIENT_ERROR
  * ZENDESK:CONNECTIVITY
  * ZENDESK:INTERNAL_SERVER_ERROR
  * ZENDESK:NOT_ACCEPTABLE
  * ZENDESK:NOT_FOUND
  * ZENDESK:RETRY_EXHAUSTED
  * ZENDESK:SERVER_ERROR
  * ZENDESK:SERVICE_UNAVAILABLE
  * ZENDESK:TIMEOUT
  * ZENDESK:TOO_MANY_REQUESTS
  * ZENDESK:UNAUTHORIZED
  * ZENDESK:UNSUPPORTED_MEDIA_TYPE


## Create a ticket
`<zendesk:create-ticketsjson>`
Creates a new ticket. This operation makes an HTTP POST request to the `/tickets.json` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Ticket Create Content | Content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout field  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * ZENDESK:BAD_REQUEST
  * ZENDESK:CLIENT_ERROR
  * ZENDESK:CONNECTIVITY
  * ZENDESK:INTERNAL_SERVER_ERROR
  * ZENDESK:NOT_ACCEPTABLE
  * ZENDESK:NOT_FOUND
  * ZENDESK:RETRY_EXHAUSTED
  * ZENDESK:SERVER_ERROR
  * ZENDESK:SERVICE_UNAVAILABLE
  * ZENDESK:TIMEOUT
  * ZENDESK:TOO_MANY_REQUESTS
  * ZENDESK:UNAUTHORIZED
  * ZENDESK:UNSUPPORTED_MEDIA_TYPE


## Upsert a user
`<zendesk:create-users-create-or-updatejson>`
Creates a user if the user does not already exist or updates an existing user identified by an email address or an external ID. This operation makes an HTTP POST request to the /users/create_or_update.json endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
userToUpsert | Content to use. | #[payload]  
Config Ref |  ConfigurationProvider | Name of the configuration used to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | How long Mule waits for a response to complete before the request times out.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Response Timeout** field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| How the connector streams request content to the remote service: * `AUTO` (default) Connector automatically uses the best streaming strategy based on the request content. * `ALWAYS` Connector always streams the request content. * `NEVER` Connector does not stream the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * ZENDESK:BAD_REQUEST
  * ZENDESK:CLIENT_ERROR
  * ZENDESK:CONNECTIVITY
  * ZENDESK:INTERNAL_SERVER_ERROR
  * ZENDESK:NOT_ACCEPTABLE
  * ZENDESK:NOT_FOUND
  * ZENDESK:RETRY_EXHAUSTED
  * ZENDESK:SERVER_ERROR
  * ZENDESK:SERVICE_UNAVAILABLE
  * ZENDESK:TIMEOUT
  * ZENDESK:TOO_MANY_REQUESTS
  * ZENDESK:UNAUTHORIZED
  * ZENDESK:UNSUPPORTED_MEDIA_TYPE


## Create a user
`<zendesk:create-usersjson>`
Creates a new user. This operation makes an HTTP POST request to the `/users.json` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Content that contains information for the new user | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream
| Retry strategy in case of connectivity errors.  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * ZENDESK:BAD_REQUEST
  * ZENDESK:CLIENT_ERROR
  * ZENDESK:CONNECTIVITY
  * ZENDESK:INTERNAL_SERVER_ERROR
  * ZENDESK:NOT_ACCEPTABLE
  * ZENDESK:NOT_FOUND
  * ZENDESK:RETRY_EXHAUSTED
  * ZENDESK:SERVER_ERROR
  * ZENDESK:SERVICE_UNAVAILABLE
  * ZENDESK:TIMEOUT
  * ZENDESK:TOO_MANY_REQUESTS
  * ZENDESK:UNAUTHORIZED
  * ZENDESK:UNSUPPORTED_MEDIA_TYPE


## Create a user
`<zendesk:create-usersjson>`
Creates a new user. This operation makes an HTTP POST request to the `/users.json` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Content that contains information for the new user | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout field  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * ZENDESK:BAD_REQUEST
  * ZENDESK:CLIENT_ERROR
  * ZENDESK:CONNECTIVITY
  * ZENDESK:INTERNAL_SERVER_ERROR
  * ZENDESK:NOT_ACCEPTABLE
  * ZENDESK:NOT_FOUND
  * ZENDESK:RETRY_EXHAUSTED
  * ZENDESK:SERVER_ERROR
  * ZENDESK:SERVICE_UNAVAILABLE
  * ZENDESK:TIMEOUT
  * ZENDESK:TOO_MANY_REQUESTS
  * ZENDESK:UNAUTHORIZED
  * ZENDESK:UNSUPPORTED_MEDIA_TYPE


## Search
`<zendesk:get-searchjson>`
Searches for tickets, users, and organizations based on the user’s search terms and returns a list of items that match the search terms. This operation makes an HTTP GET request to the /search.json endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Search query.  
Sort by one of the following options. If not specified, the operation sorts by relevance: * `updated_at` * `created_at` * `priority` * `status` * `ticket_type`  
Sort order  
Initial Page Number | Initial page number for the first request.  
Output Mime Type | MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration used to execute this component.  
Streaming Strategy | 
  * RepeatableInMemoryIterable
  * RepeatableFileStoreIterable
  * non-repeatable-iterable

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | How long Mule waits for a response to complete before the request times out.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Response Timeout** field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| How the connector streams request content to the remote service: * `AUTO` (default) Connector automatically uses the best streaming strategy based on the request content. * `ALWAYS` Connector always streams the request content. * `NEVER` Connector does not stream the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Array of Any  
---  
### For Configurations
### Throws
  * ZENDESK:BAD_REQUEST
  * ZENDESK:CLIENT_ERROR
  * ZENDESK:CONNECTIVITY
  * ZENDESK:INTERNAL_SERVER_ERROR
  * ZENDESK:NOT_ACCEPTABLE
  * ZENDESK:NOT_FOUND
  * ZENDESK:SERVER_ERROR
  * ZENDESK:SERVICE_UNAVAILABLE
  * ZENDESK:TIMEOUT
  * ZENDESK:TOO_MANY_REQUESTS
  * ZENDESK:UNAUTHORIZED
  * ZENDESK:UNSUPPORTED_MEDIA_TYPE


## Unauthorize
`<zendesk:unauthorize>`
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without performing the OAuth dance
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Resource Owner Id | The ID of the resource owner whose access should be invalidated  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
### For Configurations
## Update a ticket
`<zendesk:update-tickets-idjson>`
Updates a ticket. This operation makes an HTTP PUT request to the `/tickets/{id}.json` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the ticket to update  
Ticket Update Content | Content that contains the update information | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout field  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever
| Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout field  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * ZENDESK:BAD_REQUEST
  * ZENDESK:CLIENT_ERROR
  * ZENDESK:CONNECTIVITY
  * ZENDESK:INTERNAL_SERVER_ERROR
  * ZENDESK:NOT_ACCEPTABLE
  * ZENDESK:NOT_FOUND
  * ZENDESK:RETRY_EXHAUSTED
  * ZENDESK:SERVER_ERROR
  * ZENDESK:SERVICE_UNAVAILABLE
  * ZENDESK:TIMEOUT
  * ZENDESK:TOO_MANY_REQUESTS
  * ZENDESK:UNAUTHORIZED
  * ZENDESK:UNSUPPORTED_MEDIA_TYPE


## New ticket created
`<zendesk:on-new-ticket-trigger>`
Executes a Mule flow when a new ticket is created in Zendesk
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Date and time value that serves as a lower bound for detecting new tickets, for example, `2020-06-30T12:41:53Z`. Tickets added before this value are not detected by the New Ticket Created source.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Primary Node Only | Determines whether to execute this source on only the primary node when running in a cluster  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
## New user created
`<zendesk:on-new-user-trigger>`
Executes a Mule flow when a new user is created in Zendesk
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Date and time value that serves as a lower bound for detecting new users, for example, `2020-06-30T12:41:53Z`. Users added before this value are not detected by the New User Created source.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Primary Node Only | Determines whether to execute this source on only the primary node when running in a cluster  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
## Existing ticket updated
`<zendesk:on-updated-ticket-trigger>`
Initiates a Mule flow when an existing ticket is updated in Zendesk
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Date and time value that serves as a lower bound for detecting updated tickets, for example, `2020-06-30T12:41:53Z`. Tickets updated before this value are not detected by the Existing Ticket Updated source.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Primary Node Only | Determines whether to execute this source on only the primary node when running in a cluster  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
## Types
### Default Header
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Default Query Param
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Proxy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Non Proxy Hosts**  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Enabled Protocols** |  A comma-separated list of protocols enabled for this context.  
**Enabled Cipher Suites** |  A comma-separated list of cipher suites enabled for this context.  
**Trust Store**  
**Revocation Check** | 
  * Standard Revocation Check
  * Custom Ocsp Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.  
The password used to protect the truststore.  
The type of store used.  
The algorithm used by the truststore.  
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.  
### Key Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.  
The type of store used.  
When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.  
**Key Password** |  The password used to protect the private key.  
The password used to protect the keystore.  
The algorithm used by the keystore.  
### Standard Revocation Check
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Only End Entities** |  Only verify the last element of the certificate chain.  
**Prefer Crls** |  Try CRL instead of OCSP first.  
**No Fallback** |  Do not use the secondary checking method (the one not selected before).  
Avoid verification failure when the revocation server can not be reached or is busy.  
### Custom Ocsp Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The URL of the OCSP responder.  
**Cert Alias** |  Alias of the signing certificate for the OCSP response (must be in the truststore), if present.  
### Crl File
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The path to the CRL file.  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Fails Deployment** |  When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
**Reconnection Strategy** | 
  *   * Reconnect Forever
|  The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
How many reconnection attempts to make.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  A time unit that qualifies the maxIdleTime attribute  
### Http Response Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Status Code**  
**Reason Phrase**  
### Repeatable In Memory Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.  
**Buffer Size Increment** |  This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.  
**Max Buffer Size** |  The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.  
**Buffer Unit** |  Enumeration, one of: |  The unit in which all these attributes are expressed  
### Repeatable File Store Stream
File store repeatable streams require buffering, and there are different buffering strategies. Mule keeps a portion of contents in memory. If the stream contents are larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**In Memory Size** |  Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.  
**Buffer Unit** |  Enumeration, one of: |  The unit in which maxInMemorySize is expressed  
### Redelivery Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Redelivery Count** |  The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message  
**Message Digest Algorithm** |  The secure hashing algorithm to use. If not set, the default is SHA-256.  
**Message Identifier** |  Redelivery Policy Message Identifier |  Defines which strategy is used to identify the messages.  
**Object Store** |  ObjectStore |  Reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store.  
### Redelivery Policy Message Identifier
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Use Secure Hash** |  Whether to use a secure hash algorithm to identify a redelivered message.  
**Id Expression** |  Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.  
## See Also
  * Introduction to Anypoint Connectors
  * MuleSoft Help Center