Naar de hoofdinhoud
Alle collectiesIntergratiesAPI
Workspace API voorbeeld: Activity Feed en TOPdesk notificaties
Workspace API voorbeeld: Activity Feed en TOPdesk notificaties
Meer dan 5 maanden geleden bijgewerkt

Introductie

Dit gedeelte beschrijft een voorbeeld van een directe integratie tussen TOPdesk en Workspace 365, waarmee zowel de beller als de operator op de hoogte blijven van de status van hun verzoeken.

Hier is een voorbeeld van een TOPdesk-melding:

topdesk_1.png

Dit is een handleiding om de TOPdesk API te koppelen aan de Workspace 365 Activity Feed API. Mocht je problemen ervaren tijdens de configuratie, dan kunnen we je helpen met oplossingen. Echter, wij zijn geen eigenaar van TOPdesk software. Dit betekent dat je mogelijk TOPdesk ondersteuning moet raadplegen voor verdere assistentie.


TOPdesk-meldingen

Om meldingen te genereren vanuit TOPdesk-gebeurtenissen en deze weer te geven in Workspace 365, moet je begrijpen hoe de workflow in TOPdesk is opgezet en voor welke gebeurtenissen je meldingen wilt activeren.

Voor deze handleiding richten we ons alleen op gebeurtenissen in Call Management. Als voorbeeld bespreken we vier verschillende typen gebeurtenissen/meldingen die eenvoudig maar effectief zijn en het meest voorkomen voor de meeste TOPdesk-gebruikers.

In deze uitleg spreken we over twee personages:

  • Beller (degene die een incident meldt of een verzoek indient)

  • Operator (persoon werkzaam bij een servicegerichte afdeling belast met het opvolgen van incidenten en verzoeken).

Operatorvoorbeeldmeldingen

Operator John toegewezen: Operatorupdate door beller:​

updated.png
updated.png

Voorbeeldmeldingen van beller

Status van beller gewijzigd: Update van beller beschikbaar:

changed.png
updated2.png


Voorwaarden

  • Een account met administratieve rechten die toestemming heeft om machtigingsgroepen, API-gebruikers, gebeurtenissen en acties in TOPdesk te maken.

Stap 1. Genereer een Workspace 365 API-sleutel

Eerst moeten we een API-sleutel genereren voor de Workspace 365 API, zodat we toegang hebben tot de Activity Feed API van TOPdesk.

  1. Als Workspace-beheerder, ga naar "Instellingen" door op je profiel rechtsboven te klikken.

  2. Navigeer naar de sectie "Integraties" in het linker menu.

  3. Selecteer "API-instellingen".

  4. Klik op de knop "+ Nieuw" linksboven.

    1. Geef een naam op die aangeeft dat deze sleutel wordt gebruikt voor TOPdesk-meldingen.

    2. Selecteer "Activity feed API" als scope.

      new_API_key.png

  5. Klik op "Opslaan".

  6. Kopieer de API-sleutel uit het pop-upvenster.

    • Let op: Zorg ervoor dat je deze sleutel op een veilige plek bewaart. Je kunt de API-sleutel slechts één keer zien en kopiëren.

      requirements.png

  7. Klik op "Sluiten".


Stap 2. Maak een machtigingsgroep voor API-gebruiker in TOPdesk

  1. Ga in TOPdesk naar de ondersteunende bestanden instellingen en open "Machtigingsgroepen".

  2. Maak een nieuwe "Machtigingsgroep" genaamd "Workspace365-API".

  3. Controleer de subsecties in de hoofdsecties waarop de API toegang moet hebben. Voor dit voorbeeld hebben we nodig:

    • Sectie "Call Management" - subsecties "Eerstelijns oproepen" en "Tweedelijns oproepen". Machtigingen "Lezen" en "Selecties".

    • Sectie "Ondersteunende bestanden" - subsecties "Personen" en "Operators". Machtigingen "Lezen" en "Selecties".

    • Sectie "API-toegang" - subsecties "REST API". Machtigingen "Lezen".

    • Sectie "API-toegang" - subsectie "Gebruik toepassingswachtwoorden". Machtigingen "Schrijven".


Stap 3. Maak een API-gebruiker aan

Maak een nieuwe Operator die zal fungeren als de API-gebruiker. Deze gebruiker moet toegang hebben tot de scope die je wilt blootstellen op de TOPdesk API om meldingen naar Workspace 365 te kunnen sturen. Zorg ervoor dat eventuele filters zijn uitgeschakeld of op zijn minst gecontroleerd om ervoor te zorgen dat de gebruiker de juiste machtigingen heeft om informatie te raadplegen.

  1. Maak een nieuwe Operator aan (of gebruik het bestaande account als je al een TOPdesk-integratie hebt).

  2. Koppel de operator aan de eerder gemaakte machtigingsgroep "Workspace365-API" via het menu "Autorisatie".

  3. Log in met het nieuwe Operator-account en klik op het profielpictogram rechtsboven. Klik op "Mijn instellingen".

    dawn_maedows.png

  4. Scroll naar beneden naar de sectie "Toepassingswachtwoorden" en klik op "Toevoegen" om een nieuw wachtwoord te genereren voor gebruik met Workspace 365.

  5. Geef een naam op en stel een vervaldatum in.

    • Opmerking: zorg ervoor dat je een herinnering in je agenda zet om het wachtwoord te vernieuwen, omdat de integratie niet meer werkt na de vervaldatum.

  6. Klik op "Maken" om het wachtwoord te genereren.

  7. Kopieer de API-sleutel uit het pop-upvenster.

    • Opmerking: Zorg ervoor dat je deze sleutel op een veilige plek bewaart. Je kunt de API-sleutel slechts één keer zien en kopiëren.

  8. Sla je instellingen op indien nodig.


Stap 4. Maak een TOPdesk-gebeurtenis aan

TOPdesk-gebeurtenissen kunnen elk evenement zijn dat is gekoppeld aan een van de beschikbare TOPdesk-modules zoals Call Management, Problem Management, Change Management, enz. Voor deze handleiding richten we ons alleen op gebeurtenissen in Call Management, maar de concepten die we uitleggen zijn van toepassing op elk van de TOPdesk-modules.

Houd er rekening mee dat:

  • Elke module bevat verschillende gegevensvelden die kunnen worden gebruikt om gebeurtenissen te maken en te gebruiken in acties. Raadpleeg de TOPdesk (API) documentatie om ervoor te zorgen dat je de juiste velden gebruikt.

  • Gebeurtenissen kunnen niet worden hergebruikt en moeten worden geselecteerd of opnieuw worden aangemaakt voor elke module en subsectie zoals tweede lijn of andere typen oproepen. Je moet dan de stappen herhalen.

Voor ons gebruik hebben we vier aangepaste voorbeeldgebeurtenissen gedefinieerd die je zelf kunt maken:

  • WS365_Status_Melding

  • WS365Aanmelder_NieuweInteractieToegevoegd

  • WS365Operator_Toegewezen

  • WS365Operator_UpdateDoorAanmelder

Algemene instructies om een gebeurtenis te maken:

  1. Open de TOPdesk-beheertoepassing.

  2. Navigeer naar of zoek naar "Gebeurtenisverkenner".

    1. Selecteer een voorgeconfigureerde gebeurtenis.

    2. Of maak een aangepaste gebeurtenis aan als de gebeurtenis die je nodig hebt niet beschikbaar is in de lijst.

  3. Klik op de knop "Nieuwe gebeurtenis maken" rechtsboven.

  4. In het pop-upvenster, selecteer "Call Management - Eerstelijns oproep".

  5. Klik op de knop "Nieuwe gebeurtenis maken".

  6. Controleer een van de onderstaande gebeurtenisvoorbeelden. Zorg ervoor dat je de velden precies invult zoals weergegeven in de schermafbeeldingen.

  7. Klik op "Opslaan" rechtsboven.

Voorbeelden van gebeurtenissen:

statusnotification.png
newinteractionadded.png
operatorassigned.png
operatorupdatebycaller.png


Stap 5. Maak een TOPdesk-actie aan

TOPdesk Acties zijn een reactie op de gebeurtenissen die we hebben gedefinieerd in de vorige paragraaf. Acties zijn altijd gekoppeld aan een TOPdesk-gebeurtenis. Voor deze handleiding richten we ons alleen op acties in Call Management, maar de concepten die we uitleggen zijn van toepassing op elk van de TOPdesk-modules.

Houd er rekening mee dat:

  • Elke module bevat verschillende gegevensvelden die kunnen worden gebruikt om gebeurtenissen en acties te maken. Raadpleeg de TOPdesk (API) documentatie of TOPdesk-ondersteuning om ervoor te zorgen dat je de juiste velden gebruikt.

  • Acties kunnen niet worden hergebruikt en moeten worden geselecteerd of opnieuw worden aangemaakt voor elke module en subsectie. Voor acties is er een extra optie om aangepaste acties te exporteren en opnieuw te importeren. Hiermee kun je eenvoudig een aangepaste actie importeren en hernoemen zonder de hele stroom en bijbehorende variabelen opnieuw te hoeven maken.

Opmerking: we hebben kant-en-klare actiesjablonen gemaakt op basis van de onderstaande voorbeelden, zodat je ze kunt importeren en gebruiken zoals je wilt. Ze kunnen worden gedownload uit onze downloadsectie.

Onze actiesjablonen gaan ervan uit dat de e-mailadressen en UPN's van gebruikers identiek zijn. Als deze verschillend zijn, moet je een aanpassing maken in de code van de JSON-bestanden. Zoek naar de volgende code:

${_variables[\"Workspace365UPN\"]}

Vervang dit door:

${_responses["getPerson"]["body"]["networkLoginName"]}"

Het zal er in TOPdesk zo uitzien:

TopdeskCustomJSONCode.png


Voor ons gebruik hebben we vier aangepaste acties gedefinieerd die je zelf kunt maken:

  • WS365Aanmelder_StatusGewijzigd_Melding

  • WS365Aanmelder_NieuweInteractieToegevoegd_Melding

  • WS365Operator_Toegewezen_Melding

  • WS365Operator_UpdateDoorAanmelder_Melding


Maak een actie aan (WS365Aanmelder_StatusGewijzigd_Melding):

  1. Open de TOPdesk-beheertoepassing.

  2. Navigeer naar of zoek naar "Actie-explorer".

  3. Klik op de knop "Maken" rechtsboven.

  4. Selecteer "Actiesequentie".

  5. In het pop-upvenster, selecteer "Call Management - Eerstelijns oproep".

  6. Klik op "Nieuwe actiesequentie maken".

  7. Klik op "Importeren" rechtsboven.

  8. Klik nogmaals op "Importeren".

  9. Selecteer het Actiesjabloon (JSON-bestand) dat je wilt gebruiken.

  10. Je kunt de naam laten zoals die is, of wijzigen in iets dat voor jou herkenbaarder is.

  11. In de sectie "Gekoppelde gebeurtenissen", klik op het potloodpictogram.

  12. Selecteer de gebeurtenis die je wilt activeren met de actiesequentie. Dit moet een van de gebeurtenissen zijn die je hebt gemaakt in de vorige paragraaf.

    linked_events.png

  13. Vul de "Waarde" velden in de "Variabelen" sectie bovenaan de actiesequentie in.

    1. Workspace365URL = Workspace URL inclusief de tenantnaam zonder / aan het einde.

    2. Workspace365Token = Workspace365 [API TOKEN uit Workspace 365 API-instellingen].

    3. Topdesk_url = URL van je TOPdesk-tenant zonder / aan het einde.

    4. Workspace365UPN = ${aanmelderemail}

    5. TOPdeskUser = TOPdesk API-gebruiker die je hebt aangemaakt in de voorbereidingsparagraaf (stap 3).

    6. TOPdeskAppPassword = TOPdesk App-wachtwoord dat je hebt ontvangen tijdens het maken van de API-gebruiker in de voorbereidingsparagraaf (stap 3).

      variables.png

  14. Scroll naar beneden naar de body van stap 2 en zorg ervoor dat de tekst in het segment "Titel" overeenkomt met je verwachtingen (WS365 importbestanden zijn in het Nederlands).

  15. Vink alle vakjes aan in de sectie "Beschikbaar".

    available.png

  16. Klik op "Opslaan" rechtsboven.


Herhaal de bovenstaande stappen voor de overige acties:

  • WS365Aanmelder_NieuweInteractieToegevoegd_Melding

  • WS365Operator_Toegewezen_Melding

  • WS365Operator_UpdateDoorAanmelder_Melding


Stap 6. Maak je eigen meldingen aan

Natuurlijk zijn de mogelijkheden bijna eindeloos, wat betekent dat je veel meer meldingen kunt maken voor verschillende gebeurtenissen die beschikbaar zijn in TOPdesk. Gebruik de meegeleverde sjablonen als voorbeeld en raadpleeg de TOPdesk-product- en API-documentatie om de benodigde variabelen te vinden om de informatie te extraheren en presenteren die je wilt.

Je hebt mogelijk hulp nodig van TOPdesk-ondersteuning of een TOPdesk-consultant om je te helpen de benodigde variabelen te definiëren om de melding correct weer te geven in Workspace 365.


Stap 7. Test de meldingen

Bij het maken van een actie kun je ook een trigger maken om de actie te testen. Je kunt deze trigger beschikbaar maken in het contextmenu van een kaartitem. Bijvoorbeeld in de sectie "Verwerking" onder het contextmenu "Operator", zoals weergegeven in de onderstaande schermafbeelding. Dit betekent dat je de actie handmatig kunt activeren vanuit de kaart zonder daadwerkelijk een wijziging aan te brengen op de kaart. Hierdoor kun je veilig een melding testen voordat je deze in productie brengt.

  1. Open de eerder geconfigureerde acties individueel.

  2. Klik op het potloodpictogram naast "Beschikbaar in contextmenu".

  3. Hiermee kun je selecteren in welk contextmenu je de trigger wilt laten verschijnen op het kaartitem.

  • Bijvoorbeeld "Status" of "Operator". Hiermee kun je een statuswijziging simuleren of een melding van toewijzing aan de operator zonder daadwerkelijk de waarde te wijzigen.
    ​​

    test.png

Was dit een antwoord op uw vraag?