 .. Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

 ..   http://www.apache.org/licenses/LICENSE-2.0

 .. Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.

.. _howto/connection:zendesk:

Zendesk Connection
=========================

The Zendesk connection type enables connection to Zendesk.

Default Connection IDs
----------------------

Zendesk Hook uses parameter ``zendesk_conn_id`` for Connection IDs and the value of the
parameter as ``zendesk_default`` by default.

Configuring the Connection
--------------------------
Zendesk domain
    The domain of the Zendesk cluster (should be without scheme).
    The domain field can contain the subdomain with a dot as delimiter between the domain and subdomain.

Zendesk email
    The email that will be used for authentication against the Zendesk API.

Password
    The password corresponding to the email that will be used for authentication against the Zendesk API.
