Skip to content

HR and hiring

Send Onboarding Documents From Workday

Send onboarding documents for signing when your Workday integration passes a new worker's details to an HTTP endpoint that creates the envelope.

This page describes the pattern, not Workday menus. Workday outbound connectors send data from Workday to an external system and output it as XML, according to Workday connectors. Your Workday integration, or the middleware your team uses with it, sends the new worker’s details to an HTTP endpoint you control. That endpoint makes one request to SignatureAPI. No SignatureAPI app is needed.

Before you start

  • A SignatureAPI test API key (it starts with key_test_).
  • The documents at URLs on a supported host, or uploaded to SignatureAPI first.
  • An endpoint that receives the worker’s details. This can be an inbound webhook in Make, Zapier or n8n, or a service you run. Ask your Workday administrator how your integration delivers data to it.

Send the envelope

Convert the worker’s details to JSON if your integration sends XML, then make this request from the endpoint or from the HTTP step of your tool. Map the worker’s name and email into recipients[0] and the worker id into metadata.worker_id.

HTTP request step

Settings for the "Onboarding documents" request.

SettingValue
Method POST
URL https://api.signatureapi.com/v1/envelopes
Header X-API-Key: YOUR_API_KEY

Store the key in your tool's secret or credential storage when it has one.

Header Content-Type: application/json
Body (raw JSON)The JSON below.
Body (raw JSON)
{
  "title": "Onboarding Documents - Jane Doe",
  "message": "Welcome aboard. Please review and sign your onboarding documents.",
  "metadata": {
    "source": "workday",
    "worker_id": "21001"
  },
  "topics": [
    "hr",
    "onboarding"
  ],
  "documents": [
    {
      "key": "employment_agreement",
      "url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/service-agreement.pdf",
      "format": "pdf",
      "fixed_positions": [
        {
          "place_key": "agreement_signature",
          "page": 1,
          "top": 172,
          "left": 210
        }
      ],
      "places": [
        {
          "key": "agreement_signature",
          "type": "signature",
          "recipient_key": "employee"
        }
      ]
    }
  ],
  "recipients": [
    {
      "type": "signer",
      "key": "employee",
      "name": "Jane Doe",
      "email": "jane.doe@example.com"
    }
  ]
}

data.envelope_metadata.worker_id comes back in every webhook event for this envelope. The onboarding topic lets a webhook endpoint receive only these envelopes.

Get the result back

Add a webhook endpoint in the Dashboard, in test mode, subscribed to deliverable.generated, which fires when the signed PDF is ready, with the onboarding topic. The envelope.completed event comes earlier, while the PDF may still be generating, so use it only to update a status. Anyone who knows the endpoint URL can call it, so read the envelope with your key before you act.

HTTP request step

Settings for the "Completed envelope" request.

SettingValue
Method GET
URL https://api.signatureapi.com/v1/envelopes/eb4cf433-a8af-4161-b37b-7ef57d423e56
Header X-API-Key: YOUR_API_KEY

Store the key in your tool's secret or credential storage when it has one.

Check that deliverable.status is generated. metadata.worker_id names the worker, and deliverable.url downloads the signed PDF. That link expires after an hour, so download the file in the same run and store it where your team keeps worker documents. If your account uses authenticated deliverable URLs, send your API key with the download.