Zendesk Service policy

A Zendesk Service policy contains the connection details that are used by a Zendesk Service Input or Zendesk Service Request node when connecting to a Zendesk Service application.

You can use a Zendesk Service Request node in a message flow to connect IBM® App Connect Enterprise to Zendesk Service applications and issue requests to create, retrieve, update, or delete objects such as articles, ticket attachments, tickets, or users. You can use a Zendesk Service Input node in a message flow to monitor and accept input from Zendesk Service. The Zendesk Service policy controls, at run time, access to the Zendesk Service application.

The Zendesk Service policy is created when you configure a connection between a Zendesk Service Input or Zendesk Service Request node and Zendesk Service by using the Connector Discovery wizard. During the process of discovery, account credentials are stored in the vault and connection details are stored in the Zendesk Service policy. The policy is created with a type of Zendesk Service, and the name of the policy is returned to the node and specified in the Connection tab, in the format {policyProjectName}:policyName.

You can also create, update, or delete a Zendesk Service policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking New > Discovery Connector policies and credentials.

You must deploy this policy before message flows that use the policy are started. If you redeploy a Zendesk Service policy, all message flows that are using the policy are stopped.

For more information about using Zendesk Service policies, see Using Zendesk Service with IBM App Connect Enterprise.

Table 1. Properties of the Zendesk Service policy
Property	Property name in .policyxml file	Description of properties
Zendesk Service Application Type	applicationType	This property is reserved for future use and must be set to the value `online`.
Zendesk Service Application Version	applicationVersion	This property is reserved for future use and must be set to the value `v1`.
Zendesk Service Authentication method	authenticationMethod	This property specifies the type of authentication that is used for the connection between IBM App Connect Enterprise and Zendesk Service. This value is reserved for future use and must be set to the authentication method for your account. For example, `BASIC`.
Subdomain	subdomain	The subdomain of your Zendesk Service account's URL. For example, in the URL mycompany.zendesk.com, the subdomain is `mycompany`.
Credential name	credentialName	The name of your account. For example, ZenDeskPolicy_ZendeskService1.