Introduction

Zendesk Connect lets your organization create campaigns that send messages to users on a one-time basis, or on an ongoing basis based on recurring events in your application. For example, when a user creates an account in your application, the creation event can prompt Connect to send a welcome message to the user.

To use Connect, user and event data in your application must be sent to Connect so that Connect can react to the events and send messages to the users. This documentation is intended for developers responsible for making changes to your app to start sending user and event data to Connect.

To learn about user and event data for Connect, see:

Connect provides developers with the following options for sending user and event data:

The libraries and integrations have slightly different capabilities and implementations. For example, some options provide additional functionality, such as disabling push notifications to a mobile device, or unsubscribing a user to messages.

While the developer team in an organization usually implements and maintains the code for sending user and event data to Connect, the team in charge of customer relationships sets up and manages Connect campaigns. For more information, see the documentation in the Connect Help Center.

The rest of this document covers the following topics:

Connect terminology

The Connect integration options use the following terminology:

  • Identify user - Identifying a user means sending information about a user to Connect
  • Track event - Tracking an event means sending information about a discrete event to Connect

Connect environments

Connect provides both a development and a production environment. You must decide where you want to send your user and event data -- to the development or production environment.

For example, you could start by adding a subset of users to the development environment to test your integration. When you're ready, you could then sync your users to the production environment.

Authentication

For the REST API and for all the integration options except the JavaScript library, you must specify the private key of either your development or production environment in Connect. The choice of keys determines the environment that receives the data.

For the client-side JavaScript library, you must specify a public key.

The keys are listed on the Environments page (Settings > Environments) in your Connect account.

image

Testing your integration

You can test your integration by sending test data to the development environment in Connect, then checking the Users page in Connect to monitor user updates and events.

  1. Sign in to Connect and click the Users icon on the toolbar on the upper right.

  2. On the All Users page, select Development in the sidebar.

  3. Test your integration by identifying users and tracking events.

  4. Verify the results in the All Users page:

    • If you identified a user, the new user will appear in the list after a short delay.
    • If you tracked an event, click the user in the list that you associated with the event. The user's history will appear showing all the activity, events, messages, API calls, and user attributes associated with that user.

Example:

image