I am trying to push notifications from DocuSign Connect to our webhook.
Is there any way to provide a header named Appkey and a given value when DocuSign connect pushes notifications to the provided webhook URL?
Our webhook requires a header named AppKey to access it.
Currently, I don't see any such configuration in Docusign Connect UI.
Drew is correct that custom headers can't be supplied at this time.
A possible workaround: you can supply parameters via the URL's query parameters. Eg use URL https://docusign-listener.example.com/?appkey=123
Remember that, thanks to the SSL/TLS protocol, the query parameters are NOT visible to anyone tapping the line since they are only sent after the encrypted channel is set up between the client (DocuSign) and the server (your app).
Also, if you'd like to be able to specify headers for the notification message requests, ask your DocuSign technical contact to add your organization's information to the internal ticket CONNECT-1109. Adding your information will help increase the priority of the enhancement request.
No, DocuSign Connect doesn't support custom headers.
Related
My application wants to send an email to signer for signing DocuSign (remote signing using DocuSign rest api) and after completing signing, the website should get the update that the envelope is signed and update the database.
So can I set the brand destination URL, so that the website will get the envelope Id in the merge field and we can update the database?
In this scenario do we need to use a webbook or set a brand destination URL as I said earlier?
after completing signing, the website should get the update that the envelope is signed and update the database.
Best way to handle this is to use a DocuSign webhook. You have two options:
Use the Connect Webhook feature for an account-level webhook. This will send a notification to your server (your "listener") anytime any application in the account, for any user, sends an envelope. You can set which users will trigger a notification and which events (eg envelope_sent, envelope_completed) etc.
The webhook configuration is defined for the account using the eSign settings application or via the API.
Use the eventNotification attribute of the Envelopes:create API call. You get basically the same options as the account-level webhook, but for just one envelope. You define the webhook's settings when you make the API call to send the envelope.
Here's a live example via the API Request Builder. You can configure the example with a webhook listener URL from webhook.site or from similar services.
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.
Is it possible to request from the API to resend a webhook?
From here i can see this is possible from the Admin Panel
https://www.docusign.com/blog/dsdev-adding-webhooks-application/
When a webhook request fails, the Failures screen also enables you to
resend the notification. This can be very helpful when debugging your
listener software.
I want to do the same but from the API.
Thanks!
You can use the ConnectEvents Api's.
Specifically the following api's
retryForEnvelope
Republishes Connect information for the specified envelope.
retryForEnvelopes
Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log.
In my testing, I used a web proxy to get thru the firewall here so I could send envelopes. Now I will no longer be using the proxy. Do I need to log in for each web request ( like getting the templates, creating an envelope, etc )? The way we will use docusign is like this: a client consultant will see 3 documents that need to be sent to user X. So they will create an envelope with the 3 documents and send it out. They only need to connect to Docusign for a few rest calls and then they're done. The client consultants will connect to Docusign a few times a day, maybe no times a day if there are no documents to send. I'm assuming that I should go out and see if I can connect to Docusign without a problem before attempting to send out an envelope. What workflow are other people using in similar situations? Thanks for any advice.
I think a short answer here is that every API call you make requires a form of authentication provided, whether it is username/password or an oauth token passed in the appropriate x-header in your API request. I doubt your proxy was adding this on your behalf, so IMO I do not see what you will be gaining/losing by removing the proxy.
I create a pdf on our system and then pass that to docusign for the user to sign. I want to automatically download and save the signed envelopes in our system. Is there a way for docusign to send a post request after the document is signed?
Right now, I randomly (every other hour) connect to docusign and check if the envelope is signed using the docusign api, but this is really not optimal. There are a lot of users who view the pdf in docusign and decide they don't want to sign the document.
The "DocuSign Connect" feature is designed to do exactly that -- send a POST to an endpoint you specify, in real-time, as specified Envelope events occur. Basically it works like this: you build a "listener" app (i.e., a web page that will receive POSTs from Connect), you configure Connect (within your DocuSign account (Preferences >> Connect) to specify the endpoint of your "listener" and select which Envelope events you want your listener to receive notifications for, etc., and once that Connect configuration is enabled, DocuSign will send a POST to your listener endpoint whenever the specified Envelope event(s) occur.
The DocuSign Connect Service Guide (https://10226ec94e53f4ca538f-0035e62ac0d194a46695a3b225d72cc8.ssl.cf2.rackcdn.com/connect-guide.pdf) describes Connect and how to configure/use it -- I'd suggest that you start by reviewing the guide, and post any additional questions here on SO if you run into any issues implementing Connect.