I'm using the eSign REST API
https://developers.docusign.com/docs/esign-rest-api/
I am using embedded signing and get notifications for all the events using Connect (DS webhook)
I could not find a way to listen to comments events. Like adding a new comment or read the person I should notify has a comment.
Any options to do this?
Thanks
You cannot do this using DocuSign connect. You can retrieve all the comments using the eSign REST API, but they do not trigger webhooks at this time.
To get all comments use the Comments:Get endpoint of the v2.1 eSign API
GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript
Related
My company uses DocuSign API to automate document-related tasks.
Via the API, I need to retrieve all envelopes that are expiring soon. Similar to what the DocuSign UI has in the screen below but for all users:
Can somebody point me in the right direction -- which API endpoint/method I need to use to get all envelopes that are about to expire? Is there any way to use DocuSign Connect to trigger a callback from DocuSign for each document that is about to expire?
Thank you!
Add the following to your API call (GET to /envelopes endpoint)
folder_ids=expiring_soon&folder_types=normal,inbox,sentitems&include=recipients,powerform,folders,delegations,workflow&include_purge_information=true&query_budget=10
Remember to also have from_date and to_date parameters
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/
Also, the way I found this out for you was by trying it from the web app and recording API logs, Suggest you try that too as it will mean you can find it yourself. https://www.youtube.com/watch?v=YJYTDcc7cZw
I haven't used DocuSign PowerForms before but have used Connect to receive notifications for envelope status updates from API generated signing requests. I'm trying to find out if PowerForms will also send notifications to a Connect listener for new events such as when someone completes a PowerForm document?
Yes, they do.
The reason is simple - PowerForms eventually just expose the same functionality, an envelope is created and it using all the other features of DocuSign including Connect.
You can set it up on the template from which the Powerform was created, or you can set it as an account-level connect configuration, both options should work.
I am trying to embed docusign on my website by using powerform. As of now I am using demo account and I am stuck with using DocuSign connect how would I create a sample connector and fetch XML data.
You don't contact DocuSign connect, it contacts you! (Your application.)
Use the Administration tool--in the Connect section you can add a subscription to Connect, including your application's url.
When an event that you're interested in occurs (eg Envelope.Complete), Connect will make a POST HTTPS request to your application. The body of the post will be the XML notification message with the details on the envelope that had reached the complete (signed) state.
Ask additional questions on StackOverflow if you have additional questions.
Note: your server (your listener) must be on the public internet so it can be contacted by DocuSign.
I want to implement event notification webhook method into my app. I am using docusign-java-client SDK for docusign, but I am unable to find any example using SDK. Can anyone provide some example to achieve this?
I'm sorry to report that we (DocuSign) don't yet have a Java recipe for this. We do have a Python example. Java is on the list of things to do. Perhaps someone else can provide an example in the meantime.
Here is a general description:
First, set up your webhook subscription. You can have an envelope-specific webhook subscription by including the eventNotification fields in your envelope create request.
Or you can set up a more general subscription by using the "Connect" feature. You can setup Connect subscriptions either via the DocuSign web tool, or programmatically.
As part of the subscription you provide your url for the incoming XML notification messages.
To handle them, you write a small web app using whatever web app framework is easiest for you and your stack. Your web server will receive the incoming https calls from DocuSign.
You can see what the incoming XML messages look like by using the beta Recipe Framework. Run it on Heroku. Use the embedded signing recipe and click the button to see the Webhook / Connect messages. You can then see the sorts of messages that you will receive.
Your incoming message web server will simply parse the XML messages and then handle them accordingly.
Thanks for using the webhook system. Please ask more questions here if you have any issues.
Is there a way to create the webhooks using an api. I want to automate a group creation and would help having a webhook creation api. But i cant find any doc on how to do this.
Thanks
Suppandi
Slack does not currently have an API to programmatically create webhooks, thought it is something we're planning on doing in the future. Until then, manually creating them is the recommended approach: https://my.slack.com/services/new
Stumbled on this while searching myself and now slack has api for generating incoming webhooks programmatically