Skip to main content

Save or Update Webhook

POST 
/webhook

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",
  "description": "",
  "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",
  "description": "",
  "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",
  "description": "",
  "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",
  "description": "",
  "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",
  "description": "",
  "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",
  "description": "",
  "signers": [
    {
      "name": "SIGNER_NAME",
      "email": "SIGNER_EMAIL",
      "phone": "SIGNER_PHONE"
    }
  ],
  "declinedBy": "SIGNER_EMAIL",
  "declinedAt": "TIMESTAMP",
  "createdAt": "TIMESTAMP"
}

Request​

Responses​

Successful operation