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.

2. created:

   • When document is created this event will trigger.

3. signed:

   • When document is signed by signer this event will trigger.

4. completed:

   • When document is signed by all signers this event will trigger.

5. declined:

   • When document is declined by signer this event will trigger.

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!"
}

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...