Signature Request related webhooks

This webhook is received when an event related to a signature request is triggered.

warning

If you create a signature request with a signature profile that is in EMBEDDED integration mode,
you MUST register a callback for the LAUNCHED action.
This is the way you will receive the token that will allow you to initialize the Signature Session in your application.

info

The CANCELLED and EXPIRED actions are used when no one has signed.
If at least one person has signed and the signature request expires or is canceled, the COMPLETED state is sent.
One exception: when a signer finishes a signature request with several documents and leaves some unsigned, those documents move to a new signature request created CANCELLED. Its CANCELLED webhook carries initialSignatureRequestId, the id of the original signature request, and no signatureRequestExternalId. The original signature request goes on with the signed documents and sends COMPLETED as usual. See Documents signed one by one.

The Global object received

[type : IgnisignWebhook_ActionDto]

This is the global object that is POST to your application when a webhook event is triggered.

field	type	required	description
topic	String	Yes	Fixed value : "SIGNATURE_REQUEST"
action	IGNISIGN_WEBHOOK_ACTION_SIGNATURE_REQUEST	Yes	The action that is associated to the webhook event
msgNature	IGNISIGN_WEBHOOK_MESSAGE_NATURE	Yes	The type of message
content	IgnisignWebhookDto_SignatureRequest	No	The content of the webhook
error	IgnisignError	No	Rhe eventual error
appId	string	Yes	The appId associated to the event
appEnv	IGNISIGN_APPLICATION_ENV	Yes	The appEnv associated to the event
verificationToken	string	Yes	A token that can be used to verify that the webhook comes from ignisign

SDKs treat automatically these calls and provide to you a callback registration mecanism of typed events.

When you use the SDks:

• The verificationToken is automatically verified.
• The appId and appEnv are automatically checked.
• Only topic, action, msgNature, content and error are available in the callbacks.

The Content object

[type: IgnisignWebhookDto_SignatureRequest]

field	type	required	description
signatureRequestId	string	Yes	The id of the signature request associated to the signature
signatureRequestExternalId	string	No	An external reference (your reference) if you had provided it when you have created the signature request
status	IGNISIGN_SIGNATURE_REQUEST_STATUS	No	The status of the signature request
signers	List of IgnisignWebhookDto_SignatureRequestSigner	No	A List of the signers linked to the signature request. Only provided if the signature profile associated to the signature request is configurated in an embedded mode
initialSignatureRequestId	string	No	The id of the signature request this one comes from: the initial signature request when the signature profile uses individualizeRequests, or, on a CANCELLED webhook, the signature request in which a signer finished with documents left unsigned

IgnisignWebhookDto_SignatureRequestSigner

field	type	required	description
signerId	string	Yes	The id of the signer associated to the signature
signerExternalId	string	Yes	An external reference (your reference) if you had provided it when you have created the signer
token	string	Yes	The token that can be used to initialize the signature session in your application

The Error object

[type: IgnisignError]

field	type	required	description
errorCode	IGNISIGN_ERROR_CODES	yes	The Error code
message	string	no	A human readable message describing the error
context	object (any)	no	A map of key value pairs that provide additional context to the error

Related Enumerations :

• IGNISIGN_WEBHOOK_ACTION_SIGNATURE_REQUEST :

  • INITIALIZED : Triggered when a signature request is created
  • UPDATED : Triggered when a signature request is updated
  • READY : Triggered when a signature request is ready to be signed
  • WAITING_DOCUMENTS : Triggered when a signature request is waiting for documents (document request)
  • LAUNCHED : Triggered when a signature request is launched
  • CANCELLED : Triggered when a signature request is cancelled, including a signature request created for the documents a signer left unsigned
  • EXPIRED : Triggered when a signature request is expired
  • COMPLETED : Triggered when a signature request is completed (finalized)

• IGNISIGN_WEBHOOK_MESSAGE_NATURE: Represents the nature or type of a message associated with a webhook event in the IgniSign application.

  • INFO : The message is related provided to provide information (per example a status update)
  • SUCCESS : The message is related to a success (per example a signature session is completed)
  • WARNING : The message is related to a warning (an action is completed but with some warnings)
  • ERROR : The message is related to an error (an action has failed)