Skip to content
SignBox
/
Enterprise Documentation
/
/
Webhooks
Last updated

Webhook overview

SignBox API requires that the customer business application implements webhooks to receive callbacks from the service. Two callback URLs must be set in the API request parameters: url_out and urlback.

Callback parameters

ParameterPurpose
url_outReceives the signed document (binary) when the signature process completes successfully
urlbackReceives status messages and logs as a string in an HTTP POST request

Both URLs must be publicly reachable HTTP endpoints that accept POST requests.

urlback — Status and log callbacks

The service sends status updates and log messages to the webhook URL defined in urlback. The payload is sent as a string in an HTTP POST request.

Successful response sample

{
  "status": "success",
  "message": "Signature for job 25d07648-1d35-4263-a1c0-3336eb947560 completed",
  "detail": {
    "status": "completed",
    "format": "PADES",
    "env": "sandbox",
    "jobid": "25d07648-1d35-4263-a1c0-3336eb947560"
  }
}

Error response sample

{
  "status": "error",
  "message": "Error occurred while signing document fcb54705-ea0e-46ad-9bb6-8ea6240a876f: 401 Unauthorized",
  "detail": {
    "status": "error",
    "format": "PADES",
    "env": "sandbox",
    "jobid": "fcb54705-ea0e-46ad-9bb6-8ea6240a876f"
  }
}

Implement your webhook to parse the JSON payload and handle both success and error statuses appropriately.

url_out — Signed document delivery

When the signature process completes successfully, the signed file is sent as a binary file in an HTTP POST request to the webhook URL defined in url_out.

Your endpoint must accept a binary POST body and store or process the received file. The content type and filename may be provided in the request headers.

Previous page
Next page