DocuSign Momentum 2018DocuSign Momentum 2018
{"api":"esign_rest","category":"reference"}

ConnectEvents Resource

The ConnectEvents resource provides methods that allow you to read, delete, and republish the connect logs associated with an envelope.

MethodDescription
retryForEnvelope
PUT /v2/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue

Republishes Connect information for the specified envelope.

retryForEnvelopes
PUT /v2/accounts/{accountId}/connect/envelopes/retry_queue

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.

listFailures
GET /v2/accounts/{accountId}/connect/failures

Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.

deleteFailure
DELETE /v2/accounts/{accountId}/connect/failures/{failureId}

Deletes the Connect failure log information for the specified entry.

list
GET /v2/accounts/{accountId}/connect/logs

Retrieves a list of connect log entries for your account.

Note: The enableLog setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

deleteList
DELETE /v2/accounts/{accountId}/connect/logs

Retrieves a list of connect log entries for your account.

Note: The enableLog property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

get
GET /v2/accounts/{accountId}/connect/logs/{logId}

Retrieves the specified Connect log entry for your account.

Note: The enableLog setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

delete
DELETE /v2/accounts/{accountId}/connect/logs/{logId}

Deletes a specified entry from the Connect Log.