Signatures update: expand introduction #265
Conversation
✅ Deploy Preview for criipto-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
src/pages/signatures/index.mdx
Outdated
| - **Signature order**: a basic building block of the Signatures API. Contains documents and the signatories you intend to sign them. | ||
| - **Document(s)**: PDF(s) included in the signature order. | ||
| - **Signatory**: a person invited to sign the document. Each signatory gets a unique signing link. | ||
| - **Signature seal**: a visual representation of the signature placed on the document. |
There was a problem hiding this comment.
I'm wondering if a signature seal has any other roles too? @haysch
There was a problem hiding this comment.
It provides the visual aspect of the otherwise invisible signature, as you have stated.
In addition, it can contain information such as document ID, time of signing as well as other information that can be found in the claims (via templating).
| **How to set up a basic signing flow with Idura Signatures API:** | ||
|
|
||
| 0. _Prerequisite:_ create an Idura Signatures application to get a set of client credentials. | ||
| 1. Create a signature order and upload one or more PDFs for signing. |
There was a problem hiding this comment.
To remove any ambiguity that documents can be uploaded after creation.
| 1. Create a signature order and upload one or more PDFs for signing. | |
| 1. Create a signature order with one or more PDFs for signing. |
src/pages/signatures/index.mdx
Outdated
| - **Document(s)**: PDF(s) included in the signature order. | ||
| - **Signatory**: a person invited to sign the document. Each signatory gets a unique signing link. | ||
| - **Signature seal**: a visual representation of the signature placed on the document. | ||
| - [**Webhooks**](/signatures/webhooks/): a tool for receiving real-time notifications about events in your signature orders (e.g., when a signatory has signed). |
There was a problem hiding this comment.
I am not sure we can guarantee that events are real-time - I would think it's best effort.
Either add "near" or drop the "real-time", thoughts @mickhansen?
| - [**Webhooks**](/signatures/webhooks/): a tool for receiving real-time notifications about events in your signature orders (e.g., when a signatory has signed). | |
| - [**Webhooks**](/signatures/webhooks/): a tool for receiving near real-time events in your signature orders (e.g., when a signatory has signed). |
There was a problem hiding this comment.
"near real-time" indeed
There was a problem hiding this comment.
@haysch great point, thank you! Should it be "near real-time events" or maybe "near real-time notifications about events"?
There was a problem hiding this comment.
For reference, normally one would most likely state "webhook events", e.g., https://docs.github.com/en/webhooks/webhook-events-and-payloads :)
The intro didn’t provide enough context for first-time users. It is now updated to include an overview of the Signatures flow and terminology.
nmoskaleva
force-pushed
the
update-signatures-getting-started
branch
from
50a68fd to
942a535
Compare
The intro didn’t provide enough context for first-time users. It is now updated to include an overview of the Signatures flow and terminology.