Skip to main content

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",
        "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 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 document is created through 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"
      \}

  1. signed:
    • When document is signed by 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"
    \}
  2. completed:
    • When 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"
     \}

  3. declined:
    • When document is declined by 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"
      \}

Request​

Responses​

Successful operation