Zendesk

This article is a guide to connect your Zendesk account with Checkout Champ.

circle-info

Zendesk Checkout Champ Integration Documentation


Step 1: Add an API User for Zendesk

Follow the instructions below to add an API User in Checkout Champ.

Take note of the loginId and password for Step 2.

circle-info

The user must have only “ZENDESK” listed in the IP Whitelist field. Do not list any other IP addresses.

Please remember to wait about 5 minutes after adjusting any IP Whitelist or Endpoint settings.

circle-info

The user must have access to the following endpoints:

  • Update Order

  • Query Orders

  • Refund Order

  • Cancel Order

  • Query Customers

  • Add Customer Note

  • Update Customer

  • Query Purchase

Create An API User

Step 2: Configure Zendesk

Login to Zendesk and navigate to Admin → Admin Center → Apps and integrations → Zendesk Support Apps → Marketplace

Enter the loginId and password for your Checkout Champ API user.

Step 3: Test Zendesk

Orders and customer information are retrieved from Checkout Champ based on the email address used in the Zendesk ticket. Confirm that a Zendesk ticket populates the correct information by opening a ticket created by a customer that exists within your Checkout Champ account.

Last updated