For AI agents: a documentation index is available at https://www.inkly.so/docs/api/llms.txt, and every page is available as Markdown by adding .md to its URL.

Create a webhook subscription

Webhook subscriptions

Create a webhook subscription

post/webhook-subscriptions

Subscribes a URL to document events, for automation tools such as Zapier, Make, and n8n. Deliveries are signed and retried like other Inkly webhooks, and the secret is returned only here. A subscription belongs to the key that created it: revoking the key deletes it, and Inkly deletes it when the URL answers 410 Gone. Send an Inkly-Client header of zapier, make, or n8n to label it. Each key can hold 25 subscriptions and each workspace 100. To receive events on your own server, add a webhook in API settings instead (see Receive webhooks).

Needs a key with documents:read.

Request body

  • url string Required

    Where Inkly POSTs each event. It must be a public https URL.

    Up to 2048 characters

  • events array of strings Required

    The events to send. Repeats are ignored.

    Each one of document.sent, recipient.viewed, recipient.signed, recipient.declined, document.completed, document.voided

    1 to 6 items

curl -X POST "https://www.inkly.so/api/v1/webhook-subscriptions" \
  -H "Authorization: Bearer $INKLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://hooks.zapier.com/hooks/standard/1234567/abcdef/",
    "events": [
      "document.completed"
    ]
  }'
Example response, 201
{
  "subscription": {
    "id": "4e8a2c61-5d9f-4b17-a3e0-7c2b9f6d1e58",
    "url": "https://hooks.zapier.com/hooks/standard/1234567/abcdef/",
    "events": [
      "document.completed"
    ],
    "client": "zapier",
    "created_at": "2026-11-02T15:04:05.123Z",
    "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
  }
}

Response fields

  • subscription object Required
    6 child fields
    • id UUID Required
    • url string Required
    • events array of strings Required

      Each one of document.sent, recipient.viewed, recipient.signed, recipient.declined, document.completed, document.voided

    • client string Required

      The tool that created it, from the Inkly-Client header.

      One of zapier, make, n8n, other

    • created_at timestamp Required
    • secret string Required

      Verifies each delivery's webhook-signature. It is shown only once.

Errors specific to this endpoint

Every endpoint can also return the common errors.