diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml index 9c9f2cc80..3d0c8c279 100644 --- a/docs/docs/API-docs/opensign.yaml +++ b/docs/docs/API-docs/opensign.yaml @@ -926,7 +926,140 @@ paths: tags: - Webhook summary: Save or Update Webhook - 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" + description: | + The save or update Webhook API allows you to save a webhook URL which is used to trigger events. + + ### Events: + + **1. viewed:** + - When a signer views a document, this event will trigger. + ``` + { + "event": "viewed", + "type": "DOCUMENT_TYPE", + "objectId": "DOCUMENT_ID", + "file": "DOCUMENT_URL", + "name": "DOCUMENT_NAME", + "note": "Please review and sign this document", + "signers": [ + { + "name": "SIGNER_NAME", + "email": "SIGNER_EMAIL", + "phone": "SIGNER_PHONE" + } + ], + "viewedBy": "SIGNER_EMAIL", + "viewedAt": "TIMESTAMP", + "createdAt": "TIMESTAMP" + } + ``` + + **2. created:** + - When a document is created, this event will trigger. + ``` + { + "event": "created", + "type": "DOCUMENT_TYPE", + "objectId": "DOCUMENT_ID", + "file": "DOCUMENT_URL", + "name": "DOCUMENT_NAME", + "note": "Please review and sign this document", + "signers": [ + { + "name": "SIGNER_NAME", + "email": "SIGNER_EMAIL", + "phone": "SIGNER_PHONE" + } + ], + "createdAt": "TIMESTAMP" + } + ``` + - When a document is created through the draft template API, this event will trigger. + ``` + { + "event": "created", + "type": "DOCUMENT_TYPE", + "objectId": "DOCUMENT_ID", + "file": "DOCUMENT_URL", + "name": "DOCUMENT_NAME", + "note": "Please review and sign this document", + "signers": [ + { + "name": "SIGNER_NAME", + "email": "SIGNER_EMAIL", + "phone": "SIGNER_PHONE", + "url": "SIGNING_URL" + } + ], + "createdAt": "TIMESTAMP" + } + ``` + + **3. signed:** + - When a document is signed by a signer, this event will trigger. + ``` + { + "event": "signed", + "type": "DOCUMENT_TYPE", + "objectId": "DOCUMENT_ID", + "file": "DOCUMENT_URL", + "name": "DOCUMENT_NAME", + "note": "Please review and sign this document", + "signer": { + "name": "SIGNER_NAME", + "email": "SIGNER_EMAIL", + "phone": "SIGNER_PHONE" + }, + "signedAt": "TIMESTAMP", + "createdAt": "TIMESTAMP" + } + ``` + + **4. completed:** + - When a document is signed by all signers, this event will trigger. + ``` + { + "event": "completed", + "type": "DOCUMENT_TYPE", + "objectId": "DOCUMENT_ID", + "file": "DOCUMENT_URL", + "name": "DOCUMENT_NAME", + "note": "Please review and sign this document", + "signers": [ + { + "name": "SIGNER_NAME", + "email": "SIGNER_EMAIL", + "phone": "SIGNER_PHONE" + } + ], + "certificate": "CERTIFICATE_URL", + "completedAt": "TIMESTAMP", + "createdAt": "TIMESTAMP" + } + ``` + + **5. declined:** + - When a document is declined by a signer, this event will trigger. + ``` + { + "event": "declined", + "type": "DOCUMENT_TYPE", + "objectId": "DOCUMENT_ID", + "file": "DOCUMENT_URL", + "name": "DOCUMENT_NAME", + "note": "Please review and sign this document", + "signers": [ + { + "name": "SIGNER_NAME", + "email": "SIGNER_EMAIL", + "phone": "SIGNER_PHONE" + } + ], + "declinedBy": "SIGNER_EMAIL", + "declinedAt": "TIMESTAMP", + "createdAt": "TIMESTAMP" + } + ``` operationId: save&updateWebhook requestBody: description: Provide url to create Webhook