This article provides a comprehensive guide on integrating the Zendesk API with your Bubble application, focusing on setting up the API connection.
Security and Authentication
Before you can utilize Zendesk API calls, ensure you have access to your Zendesk domain, the associated email address, and an API key.
Obtaining Your Zendesk API Key
In the Zendesk Admin Center, go to the sidebar and select "Apps and integrations," then click on APIs > Zendesk API.
Under the Settings tab, enable Token Access and click on "Add API token" to generate a new token.
(Optional) You may add a description to identify this token later.
Important: Copy and securely store the generated token immediately as it will not be fully visible once you close the settings window.
Save your settings and return to the main API page.
Configuring Your API Key in Bubble
Format your email and the generated API token into a base64-encoded string, for example: [email protected]/token:6wiIBWbGkBMo1mRDMuVwkw1EPsNkeUj95PIz2akv When encoded, it should look like this: amRvZUBleGFtcGxlLmNvbS90b2tlbjo2d2lJQldiR2tCTW8xbVJETXVWd2t3MUVQc05rZVVqOTVQSXoyYWt2 Copy this string and paste it into the "API Key" field in your Bubble application’s API connector settings.
Utilizing Zendesk API
With the API set up, you can now integrate and manage Zendesk within your Bubble application. Key API functionalities include ticket creation, user creation, and article management in the help center.
Creating a Ticket
Description: This action creates a support ticket in your Zendesk workspace.
Steps:
In your Bubble workflow editor, add the action “Zendesk Support - Create Support Ticket”.
Fill out the required fields:
companyid: Your Zendesk domain (e.g., samplecompany.zendesk.com)
ticket_body: Content of the ticket, either in plain text or HTML (use
html_bodyfor HTML content).urgency: Set the urgency (Low, Medium, High, Urgent).
subject: Title of the ticket.
name: Name of the requester.
mail: Email of the requester.
Creating a User
Description: This function creates a user in your Zendesk workspace.
Steps:
Similar to creating a ticket, use the same workflow action.
Provide necessary details like companyid, customer_role_id (if applicable), email, name, org_name, role, and optional identities for multiple email accounts.
Creating an Article
Description: Generates an article for a specific section of your help center.
Steps:
Use the action “Zendesk Support - Create Support Ticket” for articles as well.
Input required fields such as companyid, section_id, locale, title, body (HTML), and notify_subscribers.
Zendesk offers a broad array of API calls for comprehensive ticketing and help center management. For more detailed documentation on further capabilities, please visit Zendesk Developer API Reference.