Adding the Support SDK (Required)

Before adding the Support SDK to your Android project, make sure a Zendesk Support administrator has registered your app in Zendesk Support. See Registering the application in Zendesk Support in the Support Help Center.

You can add the Support SDK to your project using one of the following methods:

Adding the SDK with Gradle

  1. In Android Studio, open the build.gradle file for the app module (not for the project).

  2. Before the dependencies section, add the following repositories section:

    repositories {
        maven { url 'https://zendesk.jfrog.io/zendesk/repo' }
    }
    
  3. If you plan on using the SDK's built-in UI components, insert the following line (in bold) in the dependencies section:

    dependencies {
        implementation group: 'com.zendesk', name: 'support', version: '2.2.1'
        ...
    }
  4. If you only want to use the SDK's API providers and no UI component, insert the following line instead (in bold) in the dependencies section:

    dependencies {
        implementation group: 'com.zendesk', name: 'support-providers', version: '2.2.1'
        ...
    }

    Note: If you plan on using both the API providers and the UI components, specify 'support' as the name. 'support' gives you both.

  5. Save the file, then integrate the Support SDK in the project by selecting File > Sync Project with Gradle Files.

Adding the SDK with Maven

Make the following additions in the pom.xml file:

...
<repository>
    <id>zdsdk-repo</id>
    <name>Zendesk SDK Repo</name>
    <url>https://zendesk.jfrog.io/zendesk/repo</url>
</repository>
...
<dependency>
    <groupId>com.zendesk</groupId>
    <artifactId>support</artifactId>
    <version>2.2.1</version>
    <type>aar</type>
</dependency>
...

If you only want to use the SDK's API providers and no built-in UI component in your project, specify support-providers as artifactId. To use both the API providers and the UI components, specify support.