WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-20 14:42:37 +02:00
Code Issues Packages Projects Releases Wiki Activity

remove webhook description

Browse Source
This commit is contained in:
prafull-opensignlabs
2024-02-09 09:15:08 +05:30
committed by GitHub
parent 43c9b4db9c
commit 5d2b131c99
1 changed files with 0 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/API-docs/opensign.yaml
-78
View File
@@ -832,84 +832,6 @@ paths:
summary: Save or Update Webhook
description: |
The save or update Webhook API allow you to save webhook url which is used to trigger events
### events:
1. **created:**
- when document is created this event will trigger.
- **output**:
- {
"event": "created",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"createdAt": "TIMESTAMP"
}
2. **signed:**
- when document is signed by signer this event will trigger.
- **output**:
- {
"event": "signed",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"signedAt":"TIMESTAMP"
"createdAt": "TIMESTAMP"
}
3. **completed:**
- when document is singed by signers this event will trigger.
- **output**:
- {
"event": "completed",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"completedAt":"TIMESTAMP"
"createdAt": "TIMESTAMP"
}
4. **declined:**
- when document is declined by signer this event will trigger.
- **output**:
- {
"event": "declined",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"declinedAt":"TIMESTAMP"
"createdAt": "TIMESTAMP"
}
operationId: save&updateWebhook
requestBody:
description: Provide below parameter to create contact