Signer Webhooks

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

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 : "SIGNER"
action	IGNISIGN_WEBHOOK_ACTION_SIGNER	Yes	The action that is associated to the webhook event
msgNature	IGNISIGN_WEBHOOK_MESSAGE_NATURE	Yes	The type of message
content	IgnisignWebhookDto_Signer	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_Signer]

field	type	required	description
appId	string	Yes	The appId associated to the event
appEnv	IGNISIGN_APPLICATION_ENV	Yes	The appEnv associated to the event
signerId	string	Yes	The id of the signer associated to the signature
signerExternalId	string	No	An external reference (your reference) if you had provided it when you have created the signer
inputsAdded	list of IGNISIGN_SIGNER_CREATION_INPUT_REF	no	Provided when an input is added to a signer. Not trigerred when the signer is created

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_SIGNER :

  • CREATED : triggered when a signer is created
  • INPUTS_ADDED : triggered when inputs are added to a signer

• IGNISIGN_SIGNER_CREATION_INPUT_REF :

  • firstName : A first name input is added to the signer
  • lastName : A last name input is added to the signer
  • email : An email input is added to the signer
  • phoneNumber : A phone number input is added to the signer
  • nationality : The nationality of the signer has been added
  • birthDate : The birth date of the signer has been added
  • birthPlace : The birth place of the signer has been added
  • birthCountry : The birth country of the signer has been added

• 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)