Save or Update Webhook

POST 
/webhook

The save or update Webhook API allow you to save webhook url which is used to trigger events

events:

1. viewed:
   • When signer viewed document this event will trigger.

   {
       "event": "viewed",
       "file": "DOCUMENT_URL",
       "name": "DOCUMENT_NAME",
       "note": "Please review and sign this document",
       "description": "",
       "signers": [
         {
           "name": "SIGNER_NAME",
           "email": "SIGNER_EMAIL",
           "phone": "SIGNER_PHONE"
         }
       ],
       "viewedBy": "SIGNER_EMAIL",
       "viewedAt": "TIMESTAMP",
       "createdAt": "TIMESTAMP"
     }
2. created:
   • When document is created this event will trigger.

   {
       "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"
     }
   
3. signed:
   • When document is signed by signer this event will trigger.

   {
       "event": "signed",
       "objectId":"DOCUMENT_ID"
       "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"
   }  
4. completed:
   • When document is signed by all signers this event will trigger.

   {
      "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"
    }
   
5. declined:
   • When document is declined by signer this event will trigger.

   {
       "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"
         }
       ],
       "declinedBy": "SIGNER_EMAIL",
       "declinedAt": "TIMESTAMP",
       "createdAt": "TIMESTAMP"
     }
   

Request

application/json

Body

Provide url to create Webhook

url string

Responses

200

Successful operation

application/json

Schema

Schema

result string

Example (from schema)

{
  "result": "Webhook updated successfully!"
}

400

Something went wrong, please try again later!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Something went wrong, please try again later!"
}

401

Webhook url already exists!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Webhook url already exists!"
}

404

User not found!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "User not found!"
}

405

Invalid API Token!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Invalid API token!"
}

Loading...