Skip to content

Commit 7d46e26

Browse files
prafull-opensignlabsprafull-opensignlabs
authored
update webhook API
1 parent e2646bd commit 7d46e26

File tree

1 file changed

+134
-1
lines changed

1 file changed

+134
-1
lines changed

‎docs/docs/API-docs/opensign.yaml‎

Lines changed: 134 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -926,7 +926,140 @@ paths:
926926
tags:
927927
- Webhook
928928
summary: Save or Update Webhook
929-
description: "The save or update Webhook API allow you to save webhook url which is used to trigger events\n### events:\n\n1. **viewed:**\n - When signer viewed document this event will trigger.\n ```\n {\n \"event\": \"viewed\",\n \"type\": \"DOCUMENT_TYPE\",\n \"objectId\": \"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n }\n ],\n \"viewedBy\": \"SIGNER_EMAIL\",\n \"viewedAt\": \"TIMESTAMP\",\n \"createdAt\": \"TIMESTAMP\"\n }\n2. **created:**\n - When document is created this event will trigger.\n ```\n {\n \"event\": \"created\",\n \"type\": \"DOCUMENT_TYPE\",\n \"objectId\": \"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n }\n ],\n \"createdAt\": \"TIMESTAMP\"\n }\n \n- When document is created through draft template API this event will trigger.\n ```\n {\n \"event\": \"created\",\n \"type\": \"DOCUMENT_TYPE\",\n \"objectId\": \"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\",\n \"url\": \"SIGNING_URL\"\n }\n ],\n \"createdAt\": \"TIMESTAMP\"\n }\n \n3. **signed:**\n - When document is signed by signer this event will trigger.\n ```\n {\n \"event\": \"signed\",\n \"type\": \"DOCUMENT_TYPE\",\n \"objectId\": \"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"signer\": \n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n },\n \"signedAt\": \"TIMESTAMP\",\n \"createdAt\": \"TIMESTAMP\"\n } \n4. **completed:**\n - When document is signed by all signers this event will trigger.\n ```\n {\n \"event\": \"completed\",\n \"type\": \"DOCUMENT_TYPE\",\n \"objectId\": \"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n }\n ],\n \"certificate\": \"CERTIFICATE_URL\",\n \"completedAt\": \"TIMESTAMP\",\n \"createdAt\": \"TIMESTAMP\"\n }\n \n5. **declined:**\n - When document is declined by signer this event will trigger.\n ```\n {\n \"event\": \"declined\",\n \"type\": \"DOCUMENT_TYPE\",\n \"objectId\": \"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n }\n ],\n \"declinedBy\": \"SIGNER_EMAIL\",\n \"declinedAt\": \"TIMESTAMP\",\n \"createdAt\": \"TIMESTAMP\"\n }\n"
929+
description: |
930+
The save or update Webhook API allows you to save a webhook URL which is used to trigger events.
931+
932+
### Events:
933+
934+
**1. viewed:**
935+
- When a signer views a document, this event will trigger.
936+
```
937+
{
938+
"event": "viewed",
939+
"type": "DOCUMENT_TYPE",
940+
"objectId": "DOCUMENT_ID",
941+
"file": "DOCUMENT_URL",
942+
"name": "DOCUMENT_NAME",
943+
"note": "Please review and sign this document",
944+
"signers": [
945+
{
946+
"name": "SIGNER_NAME",
947+
"email": "SIGNER_EMAIL",
948+
"phone": "SIGNER_PHONE"
949+
}
950+
],
951+
"viewedBy": "SIGNER_EMAIL",
952+
"viewedAt": "TIMESTAMP",
953+
"createdAt": "TIMESTAMP"
954+
}
955+
```
956+
957+
**2. created:**
958+
- When a document is created, this event will trigger.
959+
```
960+
{
961+
"event": "created",
962+
"type": "DOCUMENT_TYPE",
963+
"objectId": "DOCUMENT_ID",
964+
"file": "DOCUMENT_URL",
965+
"name": "DOCUMENT_NAME",
966+
"note": "Please review and sign this document",
967+
"signers": [
968+
{
969+
"name": "SIGNER_NAME",
970+
"email": "SIGNER_EMAIL",
971+
"phone": "SIGNER_PHONE"
972+
}
973+
],
974+
"createdAt": "TIMESTAMP"
975+
}
976+
```
977+
- When a document is created through the draft template API, this event will trigger.
978+
```
979+
{
980+
"event": "created",
981+
"type": "DOCUMENT_TYPE",
982+
"objectId": "DOCUMENT_ID",
983+
"file": "DOCUMENT_URL",
984+
"name": "DOCUMENT_NAME",
985+
"note": "Please review and sign this document",
986+
"signers": [
987+
{
988+
"name": "SIGNER_NAME",
989+
"email": "SIGNER_EMAIL",
990+
"phone": "SIGNER_PHONE",
991+
"url": "SIGNING_URL"
992+
}
993+
],
994+
"createdAt": "TIMESTAMP"
995+
}
996+
```
997+
998+
**3. signed:**
999+
- When a document is signed by a signer, this event will trigger.
1000+
```
1001+
{
1002+
"event": "signed",
1003+
"type": "DOCUMENT_TYPE",
1004+
"objectId": "DOCUMENT_ID",
1005+
"file": "DOCUMENT_URL",
1006+
"name": "DOCUMENT_NAME",
1007+
"note": "Please review and sign this document",
1008+
"signer": {
1009+
"name": "SIGNER_NAME",
1010+
"email": "SIGNER_EMAIL",
1011+
"phone": "SIGNER_PHONE"
1012+
},
1013+
"signedAt": "TIMESTAMP",
1014+
"createdAt": "TIMESTAMP"
1015+
}
1016+
```
1017+
1018+
**4. completed:**
1019+
- When a document is signed by all signers, this event will trigger.
1020+
```
1021+
{
1022+
"event": "completed",
1023+
"type": "DOCUMENT_TYPE",
1024+
"objectId": "DOCUMENT_ID",
1025+
"file": "DOCUMENT_URL",
1026+
"name": "DOCUMENT_NAME",
1027+
"note": "Please review and sign this document",
1028+
"signers": [
1029+
{
1030+
"name": "SIGNER_NAME",
1031+
"email": "SIGNER_EMAIL",
1032+
"phone": "SIGNER_PHONE"
1033+
}
1034+
],
1035+
"certificate": "CERTIFICATE_URL",
1036+
"completedAt": "TIMESTAMP",
1037+
"createdAt": "TIMESTAMP"
1038+
}
1039+
```
1040+
1041+
**5. declined:**
1042+
- When a document is declined by a signer, this event will trigger.
1043+
```
1044+
{
1045+
"event": "declined",
1046+
"type": "DOCUMENT_TYPE",
1047+
"objectId": "DOCUMENT_ID",
1048+
"file": "DOCUMENT_URL",
1049+
"name": "DOCUMENT_NAME",
1050+
"note": "Please review and sign this document",
1051+
"signers": [
1052+
{
1053+
"name": "SIGNER_NAME",
1054+
"email": "SIGNER_EMAIL",
1055+
"phone": "SIGNER_PHONE"
1056+
}
1057+
],
1058+
"declinedBy": "SIGNER_EMAIL",
1059+
"declinedAt": "TIMESTAMP",
1060+
"createdAt": "TIMESTAMP"
1061+
}
1062+
```
9301063
operationId: save&updateWebhook
9311064
requestBody:
9321065
description: Provide url to create Webhook

0 commit comments

Comments
 (0)