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?
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 theexternal_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 |
| |
member.finished |
| |
reminder.executed | An manual or automatic reminder has been sent | |
procedure.started | A Signature Request has been activated | |
procedure.finished | A Signature Request has been completed, all the Signers have signed | |
procedure.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 |
| |
procedure.deleted | signature_request.deleted |
|
procedure.error | 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 successfully created | |
server_stamp.error | Electronic seal could not be created because of an error |
Updated 4 days ago