This guide assumes you have an AdobeSign Enterprise account, which is needed to leverage any API integration with a third-party tool like Avvoka. You can test the AdobeSign API with Avvoka by creating an AdobeSign Developer account here.
These steps are taken from the AdobeSign Developer Account but apply equally to Enterprise production Adobe Accounts.
You must have organisation level admin access to be able to set this up on Avvoka.
Steps
1. Login to your Adobe account and access the administrator settings.
2. Navigate to the API page. You will be notified that in order to use the API, you must create an application first. Navigate to either green box (below) in order to access the Applications page
3. From the Applications page, create a new application (see red circle below)
4. Name your application (this can be anything) and opt for the ‘Customer’ option.
5. After you have named your application, you will be navigated back to the Application main page. Click on the application, you have just created, choose ‘View / edit’ and make a note of the Application ID and Client Secret (you will need these in Avvoka later).
6. After completing step 5, click cancel on the pop-up and click on your application again, this time choosing ‘Configure OAuth for Application.
7. From the next page, in the URI redirect box, add the following URI: https://app.[stage].avvoka.com/as_callback [Note: if you are connecting to a different Avvoka server, update the square-bracketed area accordingly. For clients with whitel-label domains, then replace the ‘app’ part with your whitelabel].
8. Below this, in the Enabled Scopes section, make sure the following settings are configured and then press Save:
9. From the API Applications page, navigate to ‘Webhooks’.
10. User the + icon to create a new webhook setting:
11. In the pop-up that appears, You can call the webhook setting what you wish and choose ‘scope’ as ‘Account’.
12. The URL should be set as: https://app.stage.avvoka.com/as_webhook. [Note: if you are connecting to a different Avvoka server, update the square-bracketed area accordingly. For clients with whitel-label domains, then replace the ‘app’ part with your whitelabel].
13. In the ‘Events’ box, click the dashed lines next to the text box and choose ‘Agreement’ and ‘Agreement all events’ only from the dropdown menus.
14. Finally, In the ‘Notification parameters’, tick the following only:
Agreement Info
Agreement Document Info
Agreement Participant Info
Agreement Signed Document
15. As an Organisation Admin:
Log into Avvoka, paste the details you collected in Item 5 into the AdobeSign box on the Organisation Admin Settings page for your Organisation.
The Client ID corresponds to the Application ID from AdobeSign, you will also need the Client Secret.
You can set up the integration so that each user authenticates their AdobeSign account (they can do this in the Settings area), or you can choose to configure the integration with organisation-wide authorisation:
Set the Authorization URL as https://secure.[eu1].echosign.com. [Note, depending on where you are in the world, the square-bracketed part of the Adobe URL will change to reflect your local Adobe datacentre. You can work out which three characters to include, by following the Adobe guidance here]
Click save, after which you will be redirected to AdobeSign to authenticate your account.
Setting up a Template for AdobeSign
To indicate that an Avvoka template should be Adobe Signed, you should navigate to the advanced settings of the template and selected Adobe Sign as the 'signing method' under Document Signing Settings.
