How Can I Use a Complete Zendesk URL Instead of a Domain During Setup?

Question

The Zendesk Support connection setup form includes a Domain field that redirects authentication to <domain>.zendesk.com. However, I need Zendesk to redirect to a specific Zendesk URL so I can reauthorize the connection through the correct portal instead of the default customer view. How can I use a complete URL for authentication?

Environment

Connector: Zendesk Support

Answer

You can use the Fivetran REST API and the Connect Card flow to configure a custom Zendesk authentication redirect. To do this:

1. Use the Fivetran REST API to set up or modify a connection, including the required configuration values, such as domain.
2. Generate the Connect Card using the API and set the required custom redirect_uri within the configuration.
3. Open the Connect Card URI returned in the API response.
4. Sign in with a Zendesk user that has the required agent role, then complete the connection setup or reauthorization.

This approach allows you to use a custom OAuth redirect for Zendesk authentication, which is useful for SSO agent login flows or other supported SSO configurations that require a non-standard redirect URI.

Example: POST to create a Connect Card

curl -X POST \
  -H "Authorization: Basic <BASE64-API-KEY:API-SECRET>" \
  -H "Content-Type: application/json" \
  "https://api.fivetran.com/v1/connectors/<connector_id>/connect-card" \
  -d '{
        "connect_card_config": {
          "redirect_uri": "https://<your-subdomain>.zendesk.com/auth/v2/login/signin?role=agent",
          "hide_setup_guide": true
        }
      }'