Skip to main content

Zendesk Support Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Zendesk Support location.
zendesk_suppport.png

Zendesk Support

Create a Zendesk Support Destination​

  1. Click the + icon on the Nexset that will be sent to the Zendesk Support destination, and select the Send to Destination option from the menu.

  2. Select the Zendesk Support connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Zendesk Support instance, and click Next; or, create a new Zendesk Support credential for use in this flow.

  3. In Nexla, Zendesk Support destinations can be created using pre-built endpoint templates, which expedite destination setup for common Zendesk Support endpoints. Each template is designed specifically for the corresponding Zendesk Support endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

Zendesk Support destinations can also be configured manually, allowing you to send data to Zendesk Support endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Zendesk Support endpoints. Each template is designed specifically for the corresponding Zendesk Support endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Ticket

    This endpoint template allows you to create tickets from Nexset records. Each record results in an API call to Zendesk. Use this template when you need to automatically create tickets based on data from your Nexla flows.

    • This endpoint sends data as JSON in the request body to create new tickets. Each record from your Nexset will be sent as a separate API request to create a ticket. The request body should contain the ticket data in the format required by the Zendesk Support API, including all required fields for ticket creation.

    This endpoint sends data as JSON in the request body to create new tickets in your Zendesk Support account. Each record from your Nexset will be sent as a separate API request to create a ticket. The request body should contain the ticket data in the format required by the Zendesk Support API, including all required fields for ticket creation.

    The ticket structure must match the Zendesk Support API's expected format. Ensure your ticket data includes all required fields. For detailed information about ticket creation, request body formats, and available ticket properties, see the Zendesk Support API documentation.

    Create Many Tickets

    This endpoint template allows you to bulk create tickets from Nexset records. Groups of 100 tickets will be sent to Zendesk as a single API call of many tickets. Use this template when you need to efficiently create multiple tickets in bulk based on data from your Nexla flows.

    • This endpoint sends data as JSON in the request body to bulk create tickets. Groups of 100 tickets will be sent to Zendesk as a single API call. The request body should contain an array of ticket data in the format required by the Zendesk Support API, including all required fields for ticket creation.

    This endpoint sends data as JSON in the request body to bulk create tickets in your Zendesk Support account. Groups of 100 tickets will be sent to Zendesk as a single API call, making it more efficient than creating tickets individually. The request body should contain an array of ticket data in the format required by the Zendesk Support API, including all required fields for ticket creation.

    The ticket structure must match the Zendesk Support API's expected format. Ensure your ticket data includes all required fields. For detailed information about bulk ticket creation, request body formats, and available ticket properties, see the Zendesk Support API documentation.

Configure Manually​

Zendesk Support destinations can be manually configured to send data to any valid Zendesk Support API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Zendesk Support API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Zendesk Support API from the Method pulldown menu. The most common methods for Zendesk Support destinations are:

    • POST: For creating new tickets or resources (most common for Zendesk Support destinations)
    • PUT: For updating existing tickets or resources
    • PATCH: For partial updates to existing tickets or resources

Data Format​

  1. Select the format in which the Nexset data will be sent to the Zendesk Support API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

The Zendesk Support APIs typically expect JSON format for most operations. Choose JSON unless you have specific requirements for other formats.

API Endpoint URL​

  1. Enter the URL of the Zendesk Support API endpoint to which you want to send the Nexset data in the URL field. For create operations, the URL typically follows the pattern https://{subdomain}.zendesk.com/api/v2/{resource_type} where {subdomain} is your Zendesk subdomain and {resource_type} is the type of resource you want to create (e.g., tickets, users). For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Access Token or Basic Authentication, which is handled automatically by your credential configuration.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Zendesk Support destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Record batching is particularly useful for Zendesk Support destinations when you need to process large numbers of tickets efficiently. Batching can help reduce API calls and improve performance.

Response Webhook​

Optional

Nexla can automatically send the response received from the Zendesk Support API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Response webhooks are particularly useful for Zendesk Support destinations to track ticket creation status, ticket creation confirmations, and any error responses from the Zendesk Support API.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Zendesk Support API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Zendesk Support API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Zendesk Support API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Zendesk Support endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the Zendesk Support endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.