Naar de hoofdinhoud

ServiceTitan-integratie instellen en automatische beoordelingsverzoeken ontvangen

De complete stappen voor installatie: verkrijg je Tenant ID in ServiceTitan, registreer een app en selecteer de vijf API-scopes op developer.servicetitan.io, genereer de Client ID en Secret, en verbind ze met ReviewFlowz.

A
Geschreven door Axel Lavergne

Als dit eenmaal is ingesteld, stuurt elke taak die je als Voltooid markeert in ServiceTitan automatisch een beoordelingsverzoek naar de klant. De ontvangen beoordeling wordt vervolgens aan de technicus die de taak heeft uitgevoerd toegewezen.

De installatie bestaat uit drie onderdelen, in de volgende volgorde:

  1. ServiceTitan (go.servicetitan.com) voor het verkrijgen van je Tenant ID.

  2. ServiceTitan developer portal (developer.servicetitan.io) om een app te registreren en je Application Key te verkrijgen.

  3. Terug naar ServiceTitan, om de app aan je account te koppelen en een Client ID en Secret te genereren.

  4. ReviewFlowz, om de vier waarden in te voeren en je campagne te activeren.

Aan het einde heb je vier referenties. Drie ervan zijn noodzakelijk. Houd een kladblok bij de hand terwijl je verder gaat.

Referentie

Herkomst

Tenant ID

ServiceTitan, Instellingen > Integraties > API Applicatietoegang

Application Key

Developer portal, bij je app onder Sleutels

Client ID

Wordt gegenereerd wanneer je ServiceTitan-account wordt gekoppeld aan je app

Client Secret

Wordt op hetzelfde moment gegenereerd, slechts eenmaal getoond

Voordat je begint

Je hebt twee machtigingen binnen ServiceTitan nodig die op je gebruikersaccount moeten zijn ingesteld. Een beheerder in je team moet deze inschakelen:

  • API applicatiesleutel genereren

  • API applicatietoegang beheren

Zonder deze twee kom je niet in de developer portal. Dit is een ServiceTitan-regel, niet van ons.

Daarnaast heb je een ReviewFlowz-account nodig met een abonnement dat de integratie en technicusattributie ondersteunt, plus SMS-tegoed als je liever sms't dan e-mailt. Je kunt de onderstaande instellingen eerst voltooien en de facturering later toevoegen. Er wordt niets verzonden totdat je de campagne activeert.

Deel 1. Verkrijg je Tenant ID van ServiceTitan

De Tenant ID identificeert je ServiceTitan-account. Als je meerdere bedrijven op ServiceTitan beheert, heeft elk een eigen ID en daarom een eigen instelling nodig.

  1. In ServiceTitan, klik op het Instellingen tandwieltje bovenaan de werkbalk.

  2. Zoek in het zijpaneel naar Integraties.

  3. Open API Applicatietoegang.

  4. Je Tenant ID vind je rechtsboven op die pagina. Kopieer hem.

Laat dit tabblad open. Je komt hier terug bij Deel 3, en je ziet hetzelfde nummer onder het label Toegestane "tenant" waarde. Hiermee weet je zeker dat je het juiste nummer hebt gekopieerd.

Deel 2. Registreer een app op developer.servicetitan.io

Dit deel zorgt vaak voor verwarring, dus lees de sectie goed door voordat je verdergaat.

Ga naar developer.servicetitan.io en log in. Het inlogscherm biedt vier knoppen in twee kolommen. Kies de rechterkolom, ServiceTitan-klanten, en de knop Inloggen als gebruiker van productiomgeving. De overige knoppen leiden ofwel naar een sandbox die je echte gegevens niet kan zien.

Het inlogscherm van de ServiceTitan developer portal

Log in met jouw ServiceTitan-gegevens. Gegevens voor Enterprise Hub en Partner Portal werken hier niet; je moet een ServiceTitan-gebruikerslogin hebben.

Registreer de app

Bij Mijn Apps, klik op Nieuwe App registreren, beantwoord de vragen die ServiceTitan stelt, en je komt in het registratieformulier. De Developer Details gaan over de software waarmee de app communiceert — met ons dus — en vul die in als volgt:

  • Organisatienaam: ReviewFlowz

  • Organisatie/App Website: https://www.reviewflowz.com

  • E-mailadres: [email protected]

Het veld voor de website vereist de volledige https://. Alleen www.reviewflowz.com plakken veroorzaakt een foutmelding.

App Details daaronder gaan over de app zelf. Geef het een herkenbare naam als ReviewFlowz. De beschrijving en vragen over bouwen en onderhoud hebben geen invloed op wat de app kan doen, dus vul deze simpelweg in. Klik op Genereren bij de External Data Application GUID.

Het Registreren Nieuwe App-formulier, Developer Details en App Details

Voeg je tenant en de vijf API-scopes toe

Verderop in hetzelfde formulier is het onderdeel Tenant APIs. Voeg de Tenant ID toe die je in Deel 1 hebt gekopieerd en klik op API-scopes toevoegen.

Het Tenant APIs-gedeelte met de knop API-scopes toevoegen

Selecteer de volgende vijf:

  • Werkorders

  • Klanten

  • Locaties

  • Afspraaktoewijzingen

  • Business Units

Leestoegang is voldoende. ReviewFlowz schrijft nooit gegevens terug naar ServiceTitan. Elke scope vervult een specifieke rol, en het ontbreken ervan verbreekt niet de verbinding, maar verwijdert stilletjes een functie:

Scope

Wat het biedt

Gevolg zonder

Werkorders

De voltooide taak die het verzoek activeert

Niets werkt

Klanten

Klantnaam, e-mail en telefoon voor verzenden

Niets werkt

Locaties

Het serviceadres van de taak

We kunnen niet zien welke locatie het werk heeft uitgevoerd

Afspraaktoewijzingen

De technicus toegewezen aan de taak

Geen technici-krediet, dus geen ranglijst

Business Units

De leesbare naam van je vestiging

Je vestigingen verschijnen als ID-nummers

Het eerste bedrijf dat we verbonden hadden was goedgekeurd zonder de Locaties-scope, wat leidde tot problemen bij de opstart. Vink alle vijf aan.

Kopieer de Application Key

Sla de app op. Terug bij Mijn Apps, elke rij heeft drie iconen onder Acties. Het potlood opent de app voor bewerken, waar de Application Key vermeld staat. Kopieer die; het is je tweede referentie.

De Application Key identificeert de app, niet je account. Het verandert niet als je tenants toevoegt en blijft gelijk voor zowel de integratie als productiomgeving.

Deel 3. Verbind de app met je ServiceTitan-account

De Client ID en Client Secret bestaan nog niet. Ze worden pas aangemaakt wanneer je ServiceTitan-account toegang krijgt tot de app. Deze stap moet dus ná Deel 2 en niet ervoor komen.

Ga in ServiceTitan naar Instellingen, zoek Integraties, en open API Applicatietoegang. Dit is dezelfde pagina waarvan je je Tenant ID in Deel 1 hebt verkregen. Hier zie je alle apps die toegang hebben tot je gegevens.

Beheer API Application Access in ServiceTitan

Klik op Nieuwe app verbinden. Je app moet in de lijst verschijnen. Als de lijst leeg is, staat je Tenant ID er niet in. Ga dan terug en voeg het toe.

De Nieuwe App verbinden-selector die de geregistreerde app toont

Selecteer de app en klik op Verbinden. ServiceTitan toont de scopes die de app vraagt en jij keurt deze goed. De app krijgt dan zijn eigen detailpagina, wat handig is om te bekijken. De Toegestane "tenant" waarde toont je Tenant ID met een handige Kopieer-knop, mocht je in Deel 1 twijfels hebben gehad.

Applicatie Details die de toegestane tenantwaarde en toegekende scopes tonen

Genereer de Client ID en Client Secret

Keer terug naar de developer portal, naar Mijn Apps. Klik op het middelste pictogram, dat eruitziet als een kettinglink; dit zijn de Appverbindingen, maar ze zijn niet bewegwijzerd.

De Mijn Apps-rij met het App Connections-icoon

In Appverbindingen vind je één rij per tenant verbonden met je app. Deze rij bevat het Tenant/Netwerk ID, de Client ID, en een Genereren-knop voor de Client Secret.

App Connections met de Tenant ID, Client ID en Genereren-knop

Kopieer de Client ID. Klik op Genereren en kopieer het geheim direct, want het wordt slechts eenmaal weergegeven. Behandel het als een wachtwoord: plak het alleen in ReviewFlowz. Wij slaan het versleuteld op en tonen het nooit opnieuw.

Deel 4. Verbind ServiceTitan in ReviewFlowz

  1. Ga in ReviewFlowz naar Integraties linksonder in de zijbalk.

  2. Klik op Automatiseer beoordelingsverzoeken rechtsboven.

  3. Zoek naar ServiceTitan en klik op de kaart.

  4. Plak de vier waarden:

  5. Client ID, uit Deel 3.

  6. Client Secret, uit Deel 3.

  7. Tenant ID, uit Deel 1.

  8. App Key, uit Deel 2. Het veld is als optioneel gelabeld omdat we op onze eigen app key kunnen terugvallen, maar je hebt je eigen app geregistreerd, dus plak de jouwe.

  9. Klik op Connect ServiceTitan.

We valideren de referenties en checken de Tenant ID afzonderlijk, zodat eventuele foutmeldingen specifiek zijn:

Foutmelding

Betekenis

ServiceTitan wijst deze referenties af

De Client ID of Secret is onjuist, of het geheim is opnieuw gegenereerd na kopiëren

Referenties werken, maar die Tenant ID niet

De combinatie hoort bij een andere tenant. Controleer Deel 1 nogmaals

We konden geen app-sleutel voor deze verbinding vinden

Het veld App Key is leeg en we hebben geen alternatief. Plak de Application Key uit Deel 2

Als alles goed gaat, wordt de kaart groen en zie je het aantal voltooide taken in de afgelopen 30 dagen. Dit getal toont aan dat we toegang hebben tot je gegevens.

Daarna importeren we je geschiedenis van voltooide taken. Deze eerdere taken dragen bij aan je technicus rangschikking, en geen van hen krijgt een beoordelingsverzoek. Alleen toekomstige taken na je verbinding worden verzonden.

Deel 5. Wijs een taak toe aan een locatie

Sla dit onderdeel over als je slechts één locatie beheert.

In het ServiceTitan-instellingenpaneel kies je onder Locaties hoe je bepaalt welke locatie een taak heeft uitgevoerd:

  • Business unit, als je business units vestigingen zijn. Koppel elke business unit aan een ReviewFlowz-locatie.

  • Klantadres, als je business units productlijnen zijn in plaats van vestigingen. Wij gebruiken de locatie die het dichtst bij de klant ligt.

Stel ook Fallback in. Dit is de locatie die we gebruiken wanneer de business unit niet is gekoppeld of er geen nabijgelegen locatie is.

Als de lijst met business units leeg is, voltooi dan eerst een taak in ServiceTitan en druk op Ververs lijst.

Deel 6. Schrijf het bericht en activeer

De verbinding heeft een conceptcampagne gemaakt genaamd ServiceTitan beoordelingsverzoeken. Deze verstuurt niets totdat hij geactiveerd is.

  1. Open de campagne en klik op het tandwieltje naast de campagnetitel.

  2. Kies het kanaal. E-mail werkt direct. SMS vereist een geregistreerde afzender, wat enkele dagen kan duren, dus start met e-mail als je vandaag wilt beginnen.

  3. Schrijf je bericht, of gebruik ons standaardbericht.

  4. Stel de vertraging in. Verzenden 20 minuten na voltooiing werkt beter dan direct, omdat de technicus nog ter plekke kan zijn.

  5. Voeg een eventuele follow-up toe na enkele dagen.

  6. Stuur jezelf een test.

  7. Druk op Activeer. Je bevestigt dat je toestemming hebt om de klanten te benaderen, waarna wij de campagne op naleving beoordelen voordat deze live gaat.

Vanaf dat moment werkt het systeem automatisch. Een voltooide taak wordt een contact in Verzoeken, en het verzoek wordt verzonden na de ingestelde vertraging.

Hoe snel werkt het?

We controleren elke 15 minuten op voltooide taken in ServiceTitan. Aangezien ServiceTitan geen webhooks voor nieuwe apps beschikbaar stelt, moeten we 'polling' gebruiken, de door ServiceTitan aanbevolen aanpak. Reken op een aanvraag binnen ongeveer 15 minuten na afsluiting van de taak, plus de door jou ingestelde vertraging.

Alleen de status Voltooid activeert een verzoek. Gepland, Verzonden, In Uitvoering, In Wacht en Geannuleerd doen dat niet.

Als er iets mis gaat

De app ontbreekt in de Nieuwe App verbinden-lijst. Je Tenant ID is niet ingesteld op de app. Ga naar de developer portal, Mijn Apps, bewerk de app in het Tenant(s) gedeelte.

Alles is verbonden maar er worden geen verzoeken verstuurd. Controleer drie zaken in deze volgorde: de campagne is actief en niet concept, de taakstatus in ServiceTitan is Voltooid, en de taak is voltooid na de verbinding. Taken voor de verbinding worden alleen voor rapportage geïmporteerd en ontvangen nooit een bericht.

Vestigingen worden weergegeven als nummers. De Business Units-scope ontbreekt in je app. Voeg het toe in de developer portal en klik op Ververs lijst op de Locaties-kaart.

Beoordelingen worden niet toegewezen aan technici. De Afspraaktoewijzingen-scope ontbreekt. Als een taak meerdere technici toewijst, krijgen ze allemaal een toewijzing. Ontbreekt een enkele technicus, dan is het waarschijnlijk een incomplete toewijzing binnen ServiceTitan, niet een scope-probleem.

Je hebt het Client Secret opnieuw gegenereerd. Door opnieuw genereren vervalt het oude geheim. Vul het nieuwe geheim in ReviewFlowz in, anders stopt de synchronisatie.

Was dit een antwoord op uw vraag?