Contact Us 1-800-596-4880
  1. Homepage
  2. Zendesk Connector (1.0.0)

  3. Zendesk Connector Reference

All Connectors

Zendesk Connector 1.0 Reference - Mule 4

Configurations

Config

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Response Timeout

Number

The timeout for the request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout field

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • 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.

AUTO

Name

String

The identifier of this element used to reference it in other components

x

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

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections to keep open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the connection Idle Timeout

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

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.

false

Response Buffer Size

Number

The space, in bytes, for the buffer that stores the HTTP response.

-1

Base Uri

String

Parameter base URI, each instance/tenant gets its own

https://{subdomain}.zendesk.com/api/{apiVersion}

Authorization

String

Authorization

TLS Configuration

Tls

Reconnection

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

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections to keep open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the connection Idle Timeout

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

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.

false

Response Buffer Size

Number

The space, in bytes, for the buffer that stores the HTTP response.

-1

Username

String

The username to authenticate the requests

Password

String

The password to authenticate the requests

Base Uri

String

Parameter base URI, each instance/tenant gets its own

https://{subdomain}.zendesk.com/api/{apiVersion}

TLS Configuration

Tls

Reconnection

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
Parameters
Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Array of Default Query Param

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections to keep open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the connection Idle Timeout

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

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.

false

Response Buffer Size

Number

The space, in bytes, for the buffer that stores the HTTP response.

-1

Base Uri

String

Parameter base URI, each instance/tenant gets its own

https://{subdomain}.zendesk.com/api/{apiVersion}

TLS Configuration

Tls

Reconnection

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

String

The OAuth consumer key, as registered with the service provider

x

Consumer Secret

String

The OAuth consumer secret, as registered with the service provider

x

Authorization Url

String

The service provider’s authorization endpoint URL

https://{subdomain}.zendesk.com/oauth/authorizations/new

Access Token Url

String

The service provider’s access token endpoint URL

https://{subdomain}.zendesk.com/oauth/tokens

Scopes

String

The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation

read write

Resource Owner Id

String

The resource owner ID that each component should use if it isn’t otherwise referenced.

Before

String

The name of a flow to execute before starting the OAuth dance

After

String

The name of a flow to execute right after an accessToken has been received

Listener Config

String

A reference to an <http:listener-config /> to use to create the listener that catches the access token callback endpoint.

x

Callback Path

String

The path of the access token callback endpoint

x

Authorize Path

String

The path of the local http endpoint that triggers the OAuth dance

x

External Callback Url

String

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

String

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

Associated Sources

Operations

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

String

The name of the configuration to use.

x

Ticket Create Content

Any

Content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout field

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

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

String

The name of the configuration to use.

x

newUser

Any

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

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout field

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

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

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

String

The name of the configuration to use

x

Resource Owner Id

String

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

String

The name of the configuration to use.

x

ID

String

ID of the ticket to update

x

Ticket Update Content

Any

Content that contains the update information

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout field

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

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

Sources

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

String

The name of the configuration to use.

x

Created

String

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

Boolean

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

x

Streaming Strategy

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

A retry strategy in case of connectivity errors

Output

Type

Any

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

String

The name of the configuration to use.

x

created

String

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

Boolean

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

x

Streaming Strategy

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

A retry strategy in case of connectivity errors

Output

Type

Any

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

String

The name of the configuration to use.

x

Updated

String

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

Boolean

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

x

Streaming Strategy

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

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Types

Default Header

Field Type Description Default Value Required

Key

String

x

Value

String

x

Default Query Param

Field Type Description Default Value Required

Key

String

x

Value

String

x

Proxy

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Key Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.

Password

String

The password used to protect the truststore.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

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

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.

Type

String

The type of store used.

Alias

String

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

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the truststore), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

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

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

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

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Http Response Attributes

Field Type Description Default Value Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

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

Number

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

Number

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:

  • BYTE

  • KB

  • MB

  • GB

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

Number

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:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Message Digest Algorithm

String

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

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

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

Back to top
View on GitHub