diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml index 5649e8e2a..af65e5278 100644 --- a/docs/docs/API-docs/opensign.yaml +++ b/docs/docs/API-docs/opensign.yaml @@ -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