Back to Paligo Academy
So the first part of our journey as we discussed is to set up the integration settings for Zendesk inside Paligo. Let's go and see how to do that and also how to set up if you're using multi brand, in other words, pushing from one Paligo into multiple Zendesk instances. So let's dive in and take a look. So as we said, the first thing we're going to do is to create the connection between Zendesk and Paligo. But I wanna set the scene a little bit first. We'll be using this Zendesk, Paligo to Zendesk. It's a testing environment that we use for all sorts of different categories. As you can see, and we'll be using this to push our content just to make sure everything works okay, and you understand all the connections. So the first thing is to create our connection between Paligo and Zendesk. Now you need to go to your Zendesk gathering. I'm not gonna show you here how because it's really a Zendesk task - is you need to get an API key from Zendesk to plug into here. You're also going to need an email address in Zendesk. That email address needs to have access to guides to create and edit content in Guide. If it doesn't, this is not gonna work because the API is essentially mimicking going into Zendesk and creating a manager content there. So the email you're using to have the API must have access. So we go to your name in the top right hand corner. And click on settings. In the tab at the top, there's an option called integrations. And I've got one already, but we'll go down Zendesk. You can see the information that you need. You need to put in your Zendesk URL Now even if you've mapped your URL to a full company name, it doesn't say Zendesk, you need to know the actual account name, the instance you're using in Zendesk here. Not the map, for example. If it's www.mycontent.com, that's not what you wanna put in here. You wanna put in the, whatever the instance is before Zendesk, the email that I mentioned and the API key. Now, I mentioned here about multi brand. That's if you're using your Paligo to push to multiple Zendesk accounts, it's called multi branding Zendesk. You're gonna have one main Zendesk instance and a bunch of others because we can write in one Paligo, push those multi brands because if you do, you just choose account number two, and then you can put the details there and account number three, etcetera, etcetera. It's five built in if you want more. Please speak to support, and that should be be able to add it for you. This is also an enterprise only piece of functionality. So if you don't see it and you're on business and you need it, then please speak to your Paligo account manager to help you to add the multi brand to your account. If you're using multi brand, you need to select which account you're publishing to. So if I'm publishing to account one, I choose account number one. If I'm now gonna publish my content to account number two, so I'd select account number two. A default category ID you really should never use is, if you're public or something, for example, your save settings, if you're familiar with that, from the publishing, recording, and help that we've done. And it would save the category ID. Let's say for some reason that's deleted, so rather than pushing to a different place or creating an error, this is a default category ID that things will be published to and you can set that as hidden. Your Zendesk. Well, again, this isn't that you shouldn't really need. You can tell what's going on. The permission settings. This is essentially mimicking options you have inside your Zendesk article in sections, who it's managed by, and you should recognize it if you know Zendesk. And or who it's visible to. These are user groups, whatever you wanna call them, where you set up in Zendesk, and I can define who can see this content. Again, that's really mimicking Zendesk. As we've said the introduction, you really need to know Zendesk well before integrating with it. I've got a lot of experience of companies who've tried to integrate with Zendesk, but don't fully understand how Zendesk works. And I really suggest, if that's the case, please stop. Go into your Zendesk, manage some articles manually, create edit, get familiar with how Zendesk works before you publish. Because without that knowledge, the rest of this won't make too much sense. The same thing with published status, You can set things as draft or as published. Last time I checked it was on the Zendesk side, once you've pushed it from draft to publish, it can't go back to draft again. And taxonomies, if you're familiar with the Paligo taxonomies, where we categorize in tag content, So they can actually become labels inside Zendesk. And you use labels of different things. Again, it's a Zendesk piece of functionality. It's up to you. It can help maybe do a a search to a particular page someone's on and provide relevant content, but please check Zendesk. The first option is to publish those taxonomies as labels. And it deletes any taxonomies before it publishes. The second option of preserve Zendesk labels that will keep the labels that are in there already, and we'll just add anything additional to the categories that are being created in Paligo. Regarding these, options, I'll just mention the third one, our overwrite article attachments. There's a limit to how much space you can put inside a Zendesk article. So if you end up finding that there's some errors essentially because you keep adding more and more images to the same article. The same images again and again and again. It's you've hit that default. So in that case, I would actually select that to overwrite article attachment, maybe do it first time as well. That way they'll have no duplicate images, and less chance of you hitting your limit, in the Zendesk article size. And you can test settings if you like, and Paligo will check just to make sure the email and API are connected. And when you're done, you save. And that's all we need to do to connect our Zendesk to Paligo. Inporting your content from Zendesk. Again, this is only relevant for those of you already have Zendesk guide, Zendesk help center. I want to bring that content in Paligo. And there's very simple process pressing the buttons. However, maybe you should think before you import. Sometimes you maybe need to fix things up or just think it through. That most of the content comes in well, but let's take an example. Rather than using a note, you did this strange table. Then obviously in Paligo, that's gonna come in as a table, Paligo won't recognize it as a note. So we've got two ways of fixing it. Either you can go through your Zendesk and fix six one, maybe there's too many, maybe there's a hundred of them, maybe there's a thousand of them, or you can engage our professional services. They can take your unique angle of how you've written your content or organized your content and modify it so it would work much cleaner inside Paligo. It's something to think about as you're onboarding. Speak to your onboarding manager in the pre sales process, speak to your account manager. We can help you guide you through that. But it's important just to think about. And something else you should take into account is that later on we're going to learn, when you import your content, you don't have to publish everything in completely new articles and lose all those links that people of your customers have have bookmarked down the years. You are able to map the content from Paligo back into those exact same sections and articles where you took them from in Zendesk, and we'll discuss that further in pre flight. We've just explained all about the importing process Let me show you how it works inside Paligo. So you can go to any folder, import content, and again, obviously after you've set the settings, we go at the bottom, Zendesk. And if I click on this button here, it gives me really essentially two main options. Either to import all categories at once. I personally would recommend against that because you'd probably then need to break everything out into different publications later. So I would recommend you just do one category at a time, and these are the regular import options very briefly, this first option here, but you will try to match component with existing components. Meaning, if it finds a similar topic or note, it will try to use it. It's not an exact science. So don't expect it to work, but you can use that if you like. Even though title prefix before the articles, if you want to number the folders, otherwise they'll be numbered in alphabetical order, and also how many folder levels. So if I really just have five articles, I don't really wanna have lots of folder levels. You can just play with this as you go on. And as we often say, before you start doing things properly importing, publishing, test. Make a little, you know, category inside Zendesk, maybe some examples, also the voice of doing anything proper. And just play with this in Paligo before you happen to understand how the process works, then you can start importing your categories and maybe import your smallest category first before you import the others. As you've spoken the presentation, you should analyze the results of your import and see, "oh it's great, it's fantastic!". Or maybe we need help from professional services, or really our content is Zendesk,I'm gonna hope it's not the case, is a bit messy. It's really inconsistent. People have made their own styles. And we're gonna have to work in it either cleaning up in Zendesk or in Paligo afterwards. But first, bring something in, check, analyze, and decide the next steps. And again, please speak to your Paligo, your onboarding manager, or your customer success manager, or if you're a prospect, your account manager, ask to how we can help and guide you because we never want you to reinvent the wheel. Ask if we can help you make the most efficient way to import your Paligo content.
Mar 29, 2024
