Skip to content

Send Envelopes From Zapier With Webhooks

Create SignatureAPI envelopes from a Zap with a Webhooks by Zapier Custom Request action, and receive signing events with a Catch Hook trigger.

Zapier calls the SignatureAPI REST API through its own Webhooks by Zapier app. No SignatureAPI app is needed: one Custom Request action creates the envelope, and a Catch Hook trigger in a second Zap receives the result. This page is the concrete recipe behind the Zapier overview.

Before you start

Send the envelope

1

Add the action

In the Zap editor, add an action step, select Webhooks by Zapier, choose Custom Request in the Event dropdown and click Continue. Zapier recommends Custom Request for nested JSON arrays, and it sends the data exactly as you enter it.

2

Set the request

Set Payload Type to Raw, so no data fields are parsed, and enter https://api.signatureapi.com/v1/envelopes in URL. In Data, paste the raw JSON body below and map the recipient’s name and email, and your record id, from earlier steps. Choose POST as the method.

3

Add the key header

In Headers, add X-API-Key with your key as the value, and Content-Type with application/json.

Zapier HTTP request step

Settings for the "Service agreement" request.

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

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

Header Content-Type: application/json
Body (raw JSON)The JSON below.
Body (raw JSON)
{
  "title": "Service Agreement - Jane Doe",
  "message": "Please review and sign the service agreement.",
  "metadata": {
    "source": "zapier",
    "record_id": "rec_1042"
  },
  "topics": [
    "no_code",
    "zapier"
  ],
  "documents": [
    {
      "key": "service_agreement",
      "url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/service-agreement.pdf",
      "format": "pdf",
      "fixed_positions": [
        {
          "place_key": "signer_signature",
          "page": 1,
          "top": 172,
          "left": 210
        }
      ],
      "places": [
        {
          "key": "signer_signature",
          "type": "signature",
          "recipient_key": "signer"
        }
      ]
    }
  ],
  "recipients": [
    {
      "type": "signer",
      "key": "signer",
      "name": "Jane Doe",
      "email": "jane.doe@example.com"
    }
  ]
}

A mapped value that contains a quote or line break breaks the JSON. Map plain values such as names and emails. data.envelope_metadata.record_id comes back in every webhook event for this envelope, and the zapier topic lets an endpoint receive only these envelopes.

Get the result back

1

Create a Catch Hook trigger

Start a second Zap with Webhooks by Zapier as the trigger and Catch Hook as the event. Zapier shows the webhook URL in the Test tab, where you can copy it (Trigger Zaps from webhooks). Catch Raw Hook returns the body unparsed, which you don’t need here.

2

Register the URL in SignatureAPI

In the Dashboard, add a webhook endpoint in test mode with that URL. Subscribe to deliverable.generated, which fires when the signed PDF is ready, and add the zapier topic so only envelopes from this Zap arrive. The envelope.completed event comes earlier, while the PDF may still be generating, so use it only to update a status.

3

Read the envelope before you act

The event body tells you which envelope changed, in data.envelope_id. Anyone who knows the webhook URL can call it, so read the envelope with your key before you update anything. Add a Custom Request action with the same header, and put the envelope id from the trigger in the URL:

Zapier 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 Zapier's secret or credential storage when it has one.

Act on the response: deliverable.status is generated, metadata.record_id names your record, and deliverable.url downloads the signed PDF. That link expires after an hour, so download the file in the same run. If your account uses authenticated deliverable URLs, send your API key with the download.

While the Zap is on, Zapier answers every delivery with 200 and the response can’t be customized. SignatureAPI treats that as acknowledged. The same event can arrive twice: skip it if your record already has the signed PDF. See Webhooks for retries and duplicates.