Skip to main content

API reference

Reference

Unauthenticated event catalog and signature verification docs.

2 endpoints. Every path below is relative to the base URL.

On this page
Base URL
https://api-uat.softsages.com/core

GET/public/inkfree/webhooks/events

Webhook event catalog

No authentication required

Lists every supported webhook event type with a description and the condition that triggers it. Use these values in the eventType field when subscribing.

No authentication required.

Responses

200

The event catalog.

Returns object

FieldTypeRequiredDescription
versionstringOptional
eventsobject[]Optional
event_typestringOptional
descriptionstringOptional
triggerstringOptional
200 response
{
  "version": "1.0",
  "events": [
    {
      "event_type": "envelope.sent",
      "description": "Envelope was sent to signers.",
      "trigger": "after envelope creation and first email dispatch"
    },
    {
      "event_type": "envelope.completed",
      "description": "All signers signed and the final PDF is available.",
      "trigger": "after last signer signs successfully"
    },
    {
      "event_type": "envelope.voided",
      "description": "Envelope was voided by the sender.",
      "trigger": "when envelope status transitions to Voided"
    },
    {
      "event_type": "signer.opened",
      "description": "A signer opened the envelope for the first time.",
      "trigger": "signer's first email link click"
    },
    {
      "event_type": "signer.signed",
      "description": "A single signer completed signing (mid-flow, not final).",
      "trigger": "each signer's completion"
    },
    {
      "event_type": "signer.declined",
      "description": "A signer declined to sign the envelope.",
      "trigger": "when signer clicks Decline"
    },
    {
      "event_type": "signer.delegated",
      "description": "A signer delegated their slot to another person.",
      "trigger": "when signer submits the delegation form"
    }
  ]
}

Example request

curl
curl "https://api-uat.softsages.com/core/public/inkfree/webhooks/events"

GET/public/inkfree/webhooks/docs/verification

Signature verification reference

No authentication required

Returns the machine-readable signature contract for webhook deliveries: header list, HMAC algorithm, signature formula, timestamp tolerance, deduplication guidance, and runnable Node and Python verification samples.

No authentication required.

Responses

200

Verification reference.

Returns object

FieldTypeRequiredDescription
algorithmstringOptional
headersobjectOptional
signature_formulastringOptional
timestamp_tolerance_secondsintegerOptional
dedup_notestringOptional
node_samplestringOptional
python_samplestringOptional
200 response
{
  "algorithm": "HMAC-SHA256",
  "signature_formula": "sha256_hex( hmac( secret, timestamp + \".\" + raw_body ) )",
  "timestamp_tolerance_seconds": 300,
  "dedup_note": "Use X-Inkfree-Delivery as an idempotency key. We retry on failure so the same delivery ID may be sent more than once."
}

Example request

curl
curl "https://api-uat.softsages.com/core/public/inkfree/webhooks/docs/verification"