Migrating from Webhooks V2 to V3

Different philosophy

Webhooks on V2 are set up per Signature Request whereas in V3 they are set up for an organisation, or a workspace, with many different settings available.

⇒ The implementation is different to meet best practices and market standards

Is it possible to create a custom header X-Custom-Header from V2 into V3?

  • On v2, it is mainly used to add client_id and the API key or bearer token
  • We don't want to leave this usage of putting all the info in the header but there are other solutions:
    • For the authentification, it is not secured to put these info in the header. And with the hashmac, we answer this need
    • For the client_id, there is the external_id which allows to put the client recognition

Are the events the same?

We don't have strictly the same events to listen:

v2

v3

Use case

member.started

signer.notified
approver.notified

  • A specific Signer can now sign
  • An approver gets the information that the signature request needs its approval

member.finished

signer.done
approver.approved

  • A specific Signer has completed its Signature Request
  • An approver approved the signature request

reminder.executed

signature_request.reminder_executed

An manual or automatic reminder has been sent

procedure.started

signature_request.activated

A Signature Request has been activated

procedure.finished

signature_request.done

A Signature Request has been completed, all the Signers have signed

procedure.expired

signature_request.expired

A Signature Request has expired

procedure.created

N/A

No use detected in v3 as we now have the feature to follow the overall consumption

procedure.refused

signer.declined
approver.rejected

  • A Signers has declined the Signature Request
  • An Approver has rejected the Signature Request

procedure.deleted

signature_request.deleted
signature_request.permanently_deleted

  • The Signature Request is deleted (but still restorable)
  • The Signature Request is permanently deleted

procedure.error

signer.error
signature_request.canceled

The Signer failed to sign due to an internal error during the signing process. In that case the Signature Request is automatically cancelled

comment.created

N/A

This feature doesn't exist on the V3

server_stamp.finished

electronic_seal.done

Electronic seal successfully created

server_stamp.error

electronic_seal.error

Electronic seal could not be created because of an error