image for site

Header Name Requirements for Zendesk API Key Connections

Understand the requirements and restrictions for header names in Zendesk API key connections, including prohibited headers.

What are the header name requirements for API key connections in Zendesk?

For API key connections in Zendesk, the header name must be specified during creation and cannot exceed 128 characters. It can only contain letters, hyphens (-), and underscores (_).

Certain HTTP header names are prohibited, including 'accept', 'content-md5', and 'user-agent', among others. Additionally, headers starting with 'x-amz-', 'x-amzn-', 'x-forwarded-', and 'x-zis-' are not allowed. It's crucial to consult the API's documentation to determine the correct header name for your API key connection.


More related questions

What is an API connection in Zendesk's bot builder?

An API connection in Zendesk's bot builder allows you to securely store API credentials for services like Slack or Shopify. This connection is used to authenticate REST API calls within the bot builder's Make API call step. To create these…

How do I create an OAuth client in Zendesk?

To create an OAuth client in Zendesk, you need to configure it with specific credentials like client ID, client secret, authorization URL, token URL, and scopes. These are obtained from the external system's OAuth configuration interface. Start by…

What are the allowed domain requirements for Zendesk API connections?

Allowed domains in Zendesk API connections ensure that credentials are only used with specified hostnames, preventing accidental leaks. Each connection requires a URL hostname as an allowed domain, which cannot exceed 128 characters. The domain…

How do I create a connection in Zendesk's Admin Center?

Creating a connection in Zendesk's Admin Center involves selecting an authentication type and entering necessary credentials. Start by navigating to Apps and integrations > Connections > OAuth Clients, then click Create connection. Choose an…

What HTTP headers are used for different authentication types in Zendesk?

In Zendesk, the HTTP headers used for authentication depend on the connection's authentication type. For API key connections, the header is set during creation. Basic authentication uses 'Authorization: Basic', Bearer token uses 'Authorization:…

Can I change the authentication type of a Zendesk connection after creation?

No, once you create a connection in Zendesk, you cannot change its authentication type. The authentication method is determined during the initial setup and dictates the type of credentials stored. If you need a different authentication type, you…

Interested indeflectingover 70% of your Zendesk support tickets?

Our AI customer support agent is here to help. Trained on all your help docs, installed directly into your Zendesk account, it can be used to automate customer replies for tickets or live chat. Learn more below.
Zendesk logo

Zendesk Support Tickets

Receive new tickets by email or a support form? This integration is for you.
My AskAI integrated within Zendesk to deflect support tickets
Learn about our Zendesk ticket integration
Zendesk logo

Zendesk Messaging (live chat)

Using Zendesk's Messaging widget on your site for live chat? This integration is for you.
My AskAI integrated within Zendesk to deflect customer support live chat conversations
Learn about our Zendesk Messaging integration

Join1,000+ companies reducing their support costs and freeing up support agents for more important work

Vestd company logo — Customer of My AskAI's AI customer support agents
Genesis company logo — Customer of My AskAI's AI customer support agents
Zinc company logo — Customer of My AskAI's AI customer support agents
Customer.io company logo — Customer of My AskAI's AI customer support agents
Zeffy company logo — Customer of My AskAI's AI customer support agents
NHS company logo — Customer of My AskAI's AI customer support agents
Kontakt.io company logo — Customer of My AskAI's AI customer support agents

Reduce support costs.Spend more time on customer success.

Our AI customer support agents are already used by 👇
Companies using AI assistants on their websites