module:model/EventNotification

module:model/EventNotification

new module:model/EventNotification()

Source:

Constructs a new EventNotification.
This optional complex element allows a message to be sent a specified URL when the envelope or recipient changes status. It is similar to DocuSign Connect. For example, if an envelope changes from "Sent" to "Delivered", a message containing the updated envelope status and optionally the documents is sent to the URL. When an eventNotification is attached to an envelope using the API, it only applies to the envelope (treating the envelope as the sender). This is different from envelopes created through the console user interface, where the user is treated as the sender.

Members

(inner) deliveryMode :String

Source:
Type:
  • String

(inner) envelopeEvents :Array.<module:model/EnvelopeEvent>

Source:

A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both.

Type:

(inner) eventData :module:model/ConnectEventData

Source:

Allows you to specify the format of the information the Connect webhooks returns. For more information, see Connect webhooks with JSON notifications

Type:

(inner) events :Array.<String>

Source:
Type:
  • Array.<String>

(inner) includeCertificateOfCompletion :String

Source:

When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.

Type:
  • String

(inner) includeCertificateWithSoap :String

Source:

When set to true, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken.

Type:
  • String

(inner) includeDocumentFields :String

Source:

When set to true, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API.

Type:
  • String

(inner) includeDocuments :String

Source:

When set to true, the PDF documents are included in the message along with the updated XML.

Type:
  • String

(inner) includeEnvelopeVoidReason :String

Source:

When set to true, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message.

Type:
  • String

(inner) includeHMAC :String

Source:
Type:
  • String

(inner) includeOAuth :String

Source:
Type:
  • String

(inner) includeSenderAccountAsCustomField :String

Source:

When set to true, the sender account ID is included as a envelope custom field in the data.

Type:
  • String

(inner) includeTimeZone :String

Source:

When set to true, the envelope time zone information is included in the message.

Type:
  • String

(inner) integratorManaged :String

Source:
Type:
  • String

(inner) loggingEnabled :String

Source:

When set to true, logging is turned on for envelope events on the Web Console Connect page.

Type:
  • String

(inner) recipientEvents :Array.<module:model/RecipientEvent>

Source:

A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both.

Type:

(inner) requireAcknowledgment :String

Source:

When set to true, the DocuSign Connect service checks that the message was received and retries on failures.

Type:
  • String

(inner) signMessageWithX509Cert :String

Source:

When set to true, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope.

Type:
  • String

(inner) soapNameSpace :String

Source:

This lists the namespace in the SOAP listener provided.

Type:
  • String

(inner) url :String

Source:

Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless useSoapInterface property is set to true.

Type:
  • String

(inner) useSoapInterface :String

Source:

When set to true, this tells the Connect service that the user's endpoint has implemented a SOAP interface.

Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/EventNotification}

Source:

Constructs a EventNotification from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:model/EventNotification

Optional instance to populate.
Returns:

The populated EventNotification instance.

Type
module:model/EventNotification