Din e-signeringstjänst måste skicka webhooks till din app när en mottagare interagerar med dokumentet.

Det kan ställas in antingen när dokumentet skapas (send-endpointen) eller per konto eller användare.

Det är viktigt att din app vet vilket Upsales-kund-id (och användar-id om appen konfigureras per användare) webhooken gäller.

1 Din app tar emot en webhook från din e-signeringstjänst och startar en manuell körning med den body du fick från webhooken: en POST till /api/external/appHook med query-parametrarna customerId, appId och authenticationKey. Lägg till userId om appen konfigureras per användare. Utan den startar inte körningen.

2 Din apps /external-endpoint får ett anrop där anropets body.data innehåller webhookens data.

3 Uppdatera E-sign-dokumentet i Upsales: hämta esign-objektet från Upsales API med anropets body.apiKey och uppdatera det med PUT /esigns/:id utifrån informationen i webhooken. Anropets body innehåller bara apiKey om din app är inställd på att använda en API-nyckel.

• På varje mottagare i arrayen involved anger du datumet då mottagaren öppnade dokumentet (seen), signerade det (sign) eller avböjde det (declineDate, med orsaken i declineMsg). Om inbjudan inte kunde levereras sätter du undelivered till mail eller sms.
• Sätt state på dokumentet när det är klart: 30 när alla har signerat, 20 när en mottagare har avböjt. Dokumentet förblir väntande (10) tills du gör det.

När state sätts till 30 anger Upsales signeringsdatumet och flyttar den kopplade affärsmöjligheten till den fas som valdes när dokumentet skickades, om affärsmöjligheten fortfarande är öppen och de fält som krävs för den fasen är ifyllda.