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. More...

Inheritance diagram for DocuSign.eSign.Model.EventNotification:

Public Member Functions
	EventNotification (string DeliveryMode=default(string), List< EnvelopeEvent > EnvelopeEvents=default(List< EnvelopeEvent >), ConnectEventData EventData=default(ConnectEventData), List< string > Events=default(List< string >), string IncludeCertificateOfCompletion=default(string), string IncludeCertificateWithSoap=default(string), string IncludeDocumentFields=default(string), string IncludeDocuments=default(string), string IncludeEnvelopeVoidReason=default(string), string IncludeHMAC=default(string), string IncludeOAuth=default(string), string IncludeSenderAccountAsCustomField=default(string), string IncludeTimeZone=default(string), string IntegratorManaged=default(string), string LoggingEnabled=default(string), List< RecipientEvent > RecipientEvents=default(List< RecipientEvent >), string RequireAcknowledgment=default(string), string SignMessageWithX509Cert=default(string), string SoapNameSpace=default(string), string Url=default(string), string UseSoapInterface=default(string))
	Initializes a new instance of the EventNotification class. More...

override string	ToString ()
	Returns the string presentation of the object More...

string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object obj)
	Returns true if objects are equal More...

bool	Equals (EventNotification other)
	Returns true if EventNotification instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	DeliveryMode `[get, set]`
	Gets or Sets DeliveryMode More...

List< EnvelopeEvent >	EnvelopeEvents `[get, set]`
	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. More...

ConnectEventData	EventData `[get, set]`
	Allows you to specify the format of the information the Connect webhooks returns. For more information, see Connect webhooks with JSON notifications More...

List< string >	Events `[get, set]`
	Gets or Sets Events More...

string	IncludeCertificateOfCompletion `[get, set]`
	When set to true, the Connect Service includes the Certificate of Completion with completed envelopes. More...

string	IncludeCertificateWithSoap `[get, set]`
	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. More...

string	IncludeDocumentFields `[get, set]`
	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. More...

string	IncludeDocuments `[get, set]`
	When set to true, the PDF documents are included in the message along with the updated XML. More...

string	IncludeEnvelopeVoidReason `[get, set]`
	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. More...

string	IncludeHMAC `[get, set]`
	Gets or Sets IncludeHMAC More...

string	IncludeOAuth `[get, set]`
	Gets or Sets IncludeOAuth More...

string	IncludeSenderAccountAsCustomField `[get, set]`
	When set to true, the sender account ID is included as a envelope custom field in the data. More...

string	IncludeTimeZone `[get, set]`
	When set to true, the envelope time zone information is included in the message. More...

string	IntegratorManaged `[get, set]`
	Gets or Sets IntegratorManaged More...

string	LoggingEnabled `[get, set]`
	When set to true, logging is turned on for envelope events on the Web Console Connect page. More...

List< RecipientEvent >	RecipientEvents `[get, set]`
	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. More...

string	RequireAcknowledgment `[get, set]`
	When set to true, the DocuSign Connect service checks that the message was received and retries on failures. More...

string	SignMessageWithX509Cert `[get, set]`
	When set to true, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. More...

string	SoapNameSpace `[get, set]`
	This lists the namespace in the SOAP listener provided. More...

string	Url `[get, set]`
	Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless `useSoapInterface` property is set to true. More...

string	UseSoapInterface `[get, set]`
	When set to true, this tells the Connect service that the user's endpoint has implemented a SOAP interface. More...

Detailed Description

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.

Constructor & Destructor Documentation

◆ EventNotification()

DocuSign.eSign.Model.EventNotification.EventNotification	(	string	DeliveryMode = `default(string)`,
		List< EnvelopeEvent >	EnvelopeEvents = `default(List<EnvelopeEvent>)`,
		ConnectEventData	EventData = `default(ConnectEventData)`,
		List< string >	Events = `default(List<string>)`,
		string	IncludeCertificateOfCompletion = `default(string)`,
		string	IncludeCertificateWithSoap = `default(string)`,
		string	IncludeDocumentFields = `default(string)`,
		string	IncludeDocuments = `default(string)`,
		string	IncludeEnvelopeVoidReason = `default(string)`,
		string	IncludeHMAC = `default(string)`,
		string	IncludeOAuth = `default(string)`,
		string	IncludeSenderAccountAsCustomField = `default(string)`,
		string	IncludeTimeZone = `default(string)`,
		string	IntegratorManaged = `default(string)`,
		string	LoggingEnabled = `default(string)`,
		List< RecipientEvent >	RecipientEvents = `default(List<RecipientEvent>)`,
		string	RequireAcknowledgment = `default(string)`,
		string	SignMessageWithX509Cert = `default(string)`,
		string	SoapNameSpace = `default(string)`,
		string	Url = `default(string)`,
		string	UseSoapInterface = `default(string)`
	)

inline

Initializes a new instance of the EventNotification class.

Parameters

DeliveryMode	DeliveryMode.
EnvelopeEvents	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..
EventData	Allows you to specify the format of the information the Connect webhooks returns. For more information, see Connect webhooks with JSON notifications.
Events	Events.
IncludeCertificateOfCompletion	When set to true, the Connect Service includes the Certificate of Completion with completed envelopes. .
IncludeCertificateWithSoap	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..
IncludeDocumentFields	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. .
IncludeDocuments	When set to true, the PDF documents are included in the message along with the updated XML. .
IncludeEnvelopeVoidReason	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. .
IncludeHMAC	IncludeHMAC.
IncludeOAuth	IncludeOAuth.
IncludeSenderAccountAsCustomField	When set to true, the sender account ID is included as a envelope custom field in the data. .
IncludeTimeZone	When set to true, the envelope time zone information is included in the message. .
IntegratorManaged	IntegratorManaged.
LoggingEnabled	When set to true, logging is turned on for envelope events on the Web Console Connect page. .
RecipientEvents	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..
RequireAcknowledgment	When set to true, the DocuSign Connect service checks that the message was received and retries on failures. .
SignMessageWithX509Cert	When set to true, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. .
SoapNameSpace	This lists the namespace in the SOAP listener provided..
Url	Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless `useSoapInterface` property is set to true..
UseSoapInterface	When set to true, this tells the Connect service that the user's endpoint has implemented a SOAP interface. .

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.EventNotification.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.EventNotification.Equals ( EventNotification other )

inline

Returns true if EventNotification instances are equal

Parameters

other Instance of EventNotification to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.EventNotification.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.EventNotification.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.EventNotification.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ DeliveryMode

string DocuSign.eSign.Model.EventNotification.DeliveryMode

getset

Gets or Sets DeliveryMode

◆ EnvelopeEvents

List<EnvelopeEvent> DocuSign.eSign.Model.EventNotification.EnvelopeEvents

getset

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.

◆ EventData

ConnectEventData DocuSign.eSign.Model.EventNotification.EventData

getset

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

◆ Events

List<string> DocuSign.eSign.Model.EventNotification.Events

getset

Gets or Sets Events

◆ IncludeCertificateOfCompletion

string DocuSign.eSign.Model.EventNotification.IncludeCertificateOfCompletion

getset

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

◆ IncludeCertificateWithSoap

string DocuSign.eSign.Model.EventNotification.IncludeCertificateWithSoap

getset

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.

◆ IncludeDocumentFields

string DocuSign.eSign.Model.EventNotification.IncludeDocumentFields

getset

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.

◆ IncludeDocuments

string DocuSign.eSign.Model.EventNotification.IncludeDocuments

getset

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

◆ IncludeEnvelopeVoidReason

string DocuSign.eSign.Model.EventNotification.IncludeEnvelopeVoidReason

getset

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.

◆ IncludeHMAC

string DocuSign.eSign.Model.EventNotification.IncludeHMAC

getset

Gets or Sets IncludeHMAC

◆ IncludeOAuth

string DocuSign.eSign.Model.EventNotification.IncludeOAuth

getset

Gets or Sets IncludeOAuth

◆ IncludeSenderAccountAsCustomField

string DocuSign.eSign.Model.EventNotification.IncludeSenderAccountAsCustomField

getset

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

◆ IncludeTimeZone

string DocuSign.eSign.Model.EventNotification.IncludeTimeZone

getset

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

◆ IntegratorManaged

string DocuSign.eSign.Model.EventNotification.IntegratorManaged

getset

Gets or Sets IntegratorManaged

◆ LoggingEnabled

string DocuSign.eSign.Model.EventNotification.LoggingEnabled

getset

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

◆ RecipientEvents

List<RecipientEvent> DocuSign.eSign.Model.EventNotification.RecipientEvents

getset

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.

◆ RequireAcknowledgment

string DocuSign.eSign.Model.EventNotification.RequireAcknowledgment

getset

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

◆ SignMessageWithX509Cert

string DocuSign.eSign.Model.EventNotification.SignMessageWithX509Cert

getset

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

◆ SoapNameSpace

string DocuSign.eSign.Model.EventNotification.SoapNameSpace

getset

This lists the namespace in the SOAP listener provided.

◆ Url

string DocuSign.eSign.Model.EventNotification.Url

getset

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

◆ UseSoapInterface

string DocuSign.eSign.Model.EventNotification.UseSoapInterface

getset

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

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Model/EventNotification.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EventNotification()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ DeliveryMode

◆ EnvelopeEvents

◆ EventData

◆ Events

◆ IncludeCertificateOfCompletion

◆ IncludeCertificateWithSoap

◆ IncludeDocumentFields

◆ IncludeDocuments

◆ IncludeEnvelopeVoidReason

◆ IncludeHMAC

◆ IncludeOAuth

◆ IncludeSenderAccountAsCustomField

◆ IncludeTimeZone

◆ IntegratorManaged

◆ LoggingEnabled

◆ RecipientEvents

◆ RequireAcknowledgment

◆ SignMessageWithX509Cert

◆ SoapNameSpace

◆ Url

◆ UseSoapInterface