Zendesk - Amazon AppFlow

Zendesk

The following are the requirements and connection instructions for using Zendesk with Amazon AppFlow.

Note

You can use Zendesk as a source or a destination.

Requirements

  • To use Amazon AppFlow, you need to register the application to generate OAuth credentials that your application can use to authenticate API calls to Zendesk. This is done in Zendesk Support.

  • In Zendesk, you must create an OAuth client with the following settings:

    • Unique identifier: aws_integration_to_Zendesk

    • Redirect URL: https://console.aws.amazon.com/appflow/oauth (us-east-1) or https://region.console.aws.amazon.com/appflow/oauth (all other Regions)

For more information, see Setting up the Amazon AppFlow integration with Zendesk in the Zendesk documentation.

Connection instructions

To connect to Zendesk while creating a flow

  1. Open the Amazon AppFlow console at https://console.aws.amazon.com/appflow/.

  2. Choose Create flow.

  3. For Flow details, enter a name and description for the flow.

  4. (Optional) To use a customer managed CMK instead of the default AWS managed CMK, choose Data encryption, Customize encryption settings and then choose an existing CMK or create a new one.

  5. (Optional) To add a tag, choose Tags, Add tag and then enter the key name and value.

  6. Choose Next.

  7. Choose Zendesk from the Source name or Destination name dropdown list.

  8. Choose Connect to open the Connect to Zendesk dialog box.

    1. Under Client ID, enter your Zendesk client ID.

    2. Under Client secret, enter your Zendesk client secret.

    3. Under Account, enter the name of your instance of Zendesk.

    4. Under Data encryption, enter your AWS KMS key.

    5. Under Connection name, specify a name for your connection.

    6. Choose Continue.

Now that you are connected to your Zendesk account, you can continue with the flow creation steps as described in Getting started with Amazon AppFlow.

Tip

If you aren’t connected successfully, ensure that you have followed the instructions in the Requirements.

Notes

  • When you use Zendesk as a source, you can run schedule-triggered flows at a maximum frequency of one flow run per minute.

  • When you use Zendesk as a destination, the following additional settings are available:

Setting name Description

Insert new records

  • This is the default data transfer option.

  • When you choose this setting, Amazon AppFlow inserts your source data into the chosen Zendesk object as a new record.

Update existing records

  • When you choose this setting, Amazon AppFlow uses your source data to update existing records in Zendesk. For every source record, Amazon AppFlow looks for a matching record in Zendesk based on your criteria. You can specify matching criteria on the Map data fields page. To do so, select a field in the source application and map it to a Zendesk record ID or external field using the dropdown list.

  • When a matching record is found, Amazon AppFlow updates the record in Zendesk. If no matching record is found, Amazon AppFlow ignores the record or fails the flow per your chosen error handling option. You can specify your error handling preferences on the Configure flow page.

Upsert records

  • When you choose this setting, Amazon AppFlow performs an upsert operation in Zendesk. For every source record, Amazon AppFlow looks for a matching record in Zendesk based on your criteria. You can specify matching criteria on the Map data fields page. To do so, select a field in the source application and map it to a Zendesk external field using the dropdown list.

  • When a matching record is found, Amazon AppFlow updates the record in Zendesk. If no matching record is found, Amazon AppFlow inserts the data as a new record. Any errors in performing the operation are handled per your chosen error handling option. You can specify your error handling preferences on the Configure flow page.

Related resources