enveloper | Transactional email microservice | Email library
kandi X-RAY | enveloper Summary
kandi X-RAY | enveloper Summary
Enveloper is a small service intended to be run in your infrastructure to speed up developing and testing transactional emails in your application. Define your templates using template files and YAML, then send messages using simple API requests. See Getting Started or browse the rest of this documentation.
Support
Quality
Security
License
Reuse
Top functions reviewed by kandi - BETA
- Get the configuration tree builder .
- Render a template .
- Queues an email request .
- Serialise an attempted delivery .
- Builds a JSON response .
- Creates a server request from the given request .
- Convert an Email object to a Swift message .
- Called when the response ends
- Sends the foundation request .
- Resolve participant list .
enveloper Key Features
enveloper Examples and Code Snippets
Community Discussions
Trending Discussions on enveloper
QUESTION
Looking at the official documentation, I don't understand the difference between those 2 data points:
excludedDocuments No Array of Strings Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.
documentVisibility No documentVisibility A complex type that specifies which documents are visible to this recipient.
Do both of those properties achieve the same behavior ? If no, what is the difference ?
...ANSWER
Answered 2021-Mar-29 at 11:41@Frederic, you can think of Document Visibility as account wide feature. You can control wide access to documents. You can read about the details in this guide. Exclude Documents is even granular access, where you can restrict signers to see documents which are allowed by the wider visibility permission. Visibility on account level is controlled under Sender settings. This extensive guide has section document visibility explaining different levels
QUESTION
I'm working on an integration with the DocuSign API - so far so good. The paper version of the document I'm working with has the following paragraph:
...ANSWER
Answered 2020-Jul-30 at 14:38DocuSign doesn't have the ability to do this yet, unless you use the API or PowerForms.
If you use the API or PowerForms to create the envelope, then you can explicitly set the values of the fields. (You'll need to calculate them in your application.)
There is the current capability to automatically set the day
. To do so:
- Add a
Date sent
field - Change the Data label for the field to be
dateSigned
- Change the Formatting options for the field to have a white color so it will be invisible on the page.
- Add a formula field
- Edit the formula for the formula field. Set it to
Day([dateSigned])
- Result: the formula field will show just the day of the date that the document was signed. Eg "30" Unfortunately it will not have the "th" suffix that you'd often like for an English reader.
There is an enhancement request for this. Ask DocuSign customer service to add your information to TRI-8003
QUESTION
I'm using the DocuSign API to create envelopes and have DocuSign send the email to the recipients to begin the signing process. I'm trying to find out if it's possible to include some kind of redirect URL that DocuSign will redirect signers to when they have finished signing the document.
I'm looking through the EnvelopeRecipientTabs resource but haven't seen anything that allows me to specify a URL here, so not sure if this is even possible at all with Remote Signing? We are not using the embedded singing option and don't have any plans to at the moment so just looking to see if this is possible via Remote Signing at this stage.
...ANSWER
Answered 2020-Jul-27 at 11:17Yes, I believe you can do this, but not via the API. Instead, you set the URLs at the account level via the Brand
:
- Open the eSignature Admin tool
- Navigate to Account / Brands
- Click on the brand you want to change.
- At the bottom of the screen, Click on Destination URLs
- Set the URL for when the recipient has completed signing.
If some of your account's envelopes should redirect to your application server, and others should not (sent manually?), then you'll need more than one brand for your account. (One brand will have the redirect settings, the other will not.)
Then, when your app sends an envelope via the API, set the brandId
and brandLock
attributes in the envelopeDefinition
object.
Note that the Brand
feature is not included with all types of DocuSign accounts. Consult your DocuSign Account Mgr for more info.
QUESTION
I have envelopes that were not created by the API and so their recipients don't have the clientUserId
set.
I would like to update the clientUserId
of a recipient so I can redirect them to sign the envelope with the createRecipientView
method.
The problem is when I make the update (EnvelopeRecipients::update) DocuSign issues a correction, and makes the envelope unavailable for the other recipients, sending out an email that they no longer can access the document.
How can I prevent this correction?
*Edit: As far as I can tell the correction only applies to the recipient whose clientUserId
is updated. Is this correct? Is it not possible for the recipient to sign both from their email and from the embedded flow? I can suppress the email with the suppressEmails
field for the given signer, but they still won't be able to open the document from their email anymore.
ANSWER
Answered 2020-Jul-22 at 15:59If the envelope is in "draft" (created) state - would should be able to do that. If the envelope was already sent - it has to be corrected. That's a legal requirement. It was sent to some recipient and now you modify it (in any way) then it's technically a correction, you can't avoid this.
QUESTION
I am working with composite template because I need to include multiple templates in the envelope. In all templates, signing roles are same. I have following roles and signing order.
I also have need to provide custom email subject and body for each role, when I create envelope.
Here is my request json to create envelope using composite template. Purposefully left second composite template section empty so that its not too big.
...ANSWER
Answered 2020-Jun-05 at 22:20Answer # 1
I do not believe so. If this workflow is a common occurrence, you might consider creating a third template containing the documents & tabs of the first two templates.
Then, you could simply send an envelope containing just that third template. In this case, you would only have to specify the recipient's information once.
However, we usually advise the composite templates pattern since it's far easier to customize and scale when your use case changes in the future.
Answer # 2
No. You are mixing two different DocuSign design patterns, i.e you should not mix Composite Template and TemplateRole.
Template Role is needed when you have one server template and you want to prepopulate the signer information and/or any DocuSign tab information present in the template from your application.
What you can do (which I'm sure you've realized) is to retrieve the signing authorities for the templates with a GET /template
before making your POST /envelopes
containing composite templates.
QUESTION
Im getting the envelopes recipients using the GET envelopes/{envelope_id}/recipients
endpoint.
After that i add the field clientUserId
and try to update the envelope, using the POST envelopes/{envelope_id}/recipients' endpoint with the very same array that i got from return from GET method as body.
But is returned the following error:
"The request body is missing or improperly formatted. Cannot deserialize the current JSON array (e.g. [1,2,3]) into type 'API_REST.Models.v2.recipientIdentityVerification' because the type requires a JSON object (e.g. {"name":"value"}) to deserialize correctly.
To fix this error either change the JSON to a JSON object (e.g. {"name":"value"}) or change the deserialized type to an array or a type that implements a collection interface (e.g. ICollection, IList) like List that can be deserialized from a JSON array. JsonArrayAttribute can also be added to the type to force it to deserialize from a JSON array.
Path 'signers[0].identityVerification', line 1, position 120."
Obs: This was working last time i tested (december/2018)
UPDATE:
I enabled the Log, but seems that the error is not being logged, as you can see, all the requests in log are "OK", and I didn't find the POST envelopes/{envelope_id}/recipients.
Here are the logs files:
...ANSWER
Answered 2019-Jun-01 at 18:05Since you don't see the error in the DocuSign logs, and also from the wording of the error, I suspect that the problem is happening within your machine, before the request is sent to DocuSign.
So the solution is to debug within your application. For more help, please provide your code which causes the error to be raised.
QUESTION
I am trying to set the email body for a signer in my DocuSign envelope using the REST API. I am setting it using the emailNotification property for the EnvelopeRecipient (https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients).
My concern is that the email body is HTML that has some links, but those links are not clickable in the email. Is there any way to allow for links to be clickable/navigatable?
...ANSWER
Answered 2019-May-29 at 22:19There's a back-end setting for Allow HTML input in the API
.
You won't be able to configure this setting yourself - you can either reach out to your Account Manager, or have an administrator on the account open a case with DocuSign Support to request that setting be enabled.
If you open a support case, be sure to include your Sandbox account ID if you would like to have it enabled in the Demo environment as well.
QUESTION
From https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients I can see that when creating an Envelope Recipient, you can specify a list of documents within the DocuSign envelope that the Envelope Recipient cannot view.
I want to use similar functionality when creating a recipient view request (ie. https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeViews/createRecipient#recipientViewRequest). Specifically, when creating a recipient view request I want to specify which documents the viewer can see/not see. However, I do not see an ExcludedDocuments parameter or similar.
How can I
...ANSWER
Answered 2019-Apr-30 at 11:23The RecipientView is simply the API method for obtaining an URL to a Signing Ceremony for a particular recipient.
If you don't want a recipient to see a document, then you must use Document Visibility--that includes using the excludedDocuments
attribute, but other attributes and tabs need to be set up too.
Once you have an envelope with document visibility set up for some/all of the recipients, you can use RecipientView to obtain the URL for a specific recipient's signing ceremony.
QUESTION
Where can I find the recipient status codes (created, delivered, etc.) and the status's meaning?
I've tried various Google searches and went through the REST API documentation, but I can't find anything. Thanks!
...ANSWER
Answered 2018-Dec-04 at 20:00In the DocuSign Developer Center for the REST API family you can go to the Guides -> Features -> Recipients page which has the list of recipient statuses. See the following page:
https://developers.docusign.com/esign-rest-api/guides/features/recipients#recipient-statuses
For reference, here are the statuses listed on the above page:
created
: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a Created status).
sent
: The recipient has been sent an email notification that it is their turn to sign an envelope.
delivered
: The recipient has viewed the document(s) in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope.
signed
: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to Completed.
declined
: The recipient declined to sign the document(s) in the envelope.
completed
: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.
faxpending
: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step.
autoresponded
: The recipient's email system auto-responded (bounced-back) to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email.
QUESTION
I'm having a hard time getting data from my code into the template using the c# library.
I have a template setup that I added a text box to using the online template edit tool. I'm trying to update the value of that text box with it's Data Label. Could I get a c# example of this?
This is the snippet from my current code:
...ANSWER
Answered 2018-May-18 at 22:12The name.TabLabel
property needs to exactly match the label used in your template. So, for example, if your tag was set up like this:
you would use name.TabLabel = "Text1";
. Setting name.Value = "My Name";
would then populate that tag with 'My Name', assuming your template is being referenced and your signer is mapped to the template role.
Code sample for sending from a template with tags populated follows. This assumes the signer role name is "Signer 1" and the tag label is "Text 1"
Community Discussions, Code Snippets contain sources that include Stack Exchange Network
Vulnerabilities
No vulnerabilities reported
Install enveloper
PHP requires the Visual C runtime (CRT). The Microsoft Visual C++ Redistributable for Visual Studio 2019 is suitable for all these PHP versions, see visualstudio.microsoft.com. You MUST download the x86 CRT for PHP x86 builds and the x64 CRT for PHP x64 builds. The CRT installer supports the /quiet and /norestart command-line switches, so you can also script it.
Support
Reuse Trending Solutions
Find, review, and download reusable Libraries, Code Snippets, Cloud APIs from over 650 million Knowledge Items
Find more librariesStay Updated
Subscribe to our newsletter for trending solutions and developer bootcamps
Share this Page