Signature Profile Webhooks

This webhook is received when events related to a signature profile are 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 : "SIGNATURE_PROFILE"
action	IGNISIGN_WEBHOOK_ACTION_SIGNATURE_PROFILE	Yes	The action that is associated to the webhook event
msgNature	IGNISIGN_WEBHOOK_MESSAGE_NATURE	Yes	The type of message
content	IgnisignWebhookDto_SignatureProfile	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_SignatureProfile ]

field	type	required	description
signatureProfileId	string	Yes	The signature profile id related to the event

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

  • CREATED : Action triggered when a signature profile is created
  • ARCHIVED : Action triggered when a signature profile is archived

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