Register a webhook URL (returns the signing secret once)

POST

/webhook/save/

const url = 'https://app.qsig.in/backend/othercompanyapi/webhook/save/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"webhook_url":"https://example.com/qsign/webhook"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.qsig.in/backend/othercompanyapi/webhook/save/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "webhook_url": "https://example.com/qsign/webhook" }'

Register a public HTTPS webhook URL with an api_admin login JWT (Authorization: Bearer). Returns webhook_secret for verifying timestamped HMAC-SHA256 envelope events such as envelope.completed. Envelope calls themselves use X-Api-Key.

Authorizations

BearerAuth

Request Body^required

application/json

object

webhook_url

required

Public HTTPS receiver URL.

string format: uri

Example

{
  "webhook_url": "https://example.com/qsign/webhook"
}

Responses

200

Saved

application/json

object

webhook_secret

string

Example ^generated

{
  "webhook_secret": "example"
}