Sign in

v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Papersign Webhooks

This endpoint returns a creates a new webhook for a Papersign Folder. Please note that this feature is exclusively available as part of the Papersign API.

post/papersign/folders/{id}/webhooks

Path parameters

idnumber required

The ID of the Papersign folder.

Request body

namestring

The name of the webhook.

target_urlstring uri

The target URL for the webhook.

scope'folder.direct_children' | 'folder.all_descendants'

The scope of the webhook.

triggersstring[]

The triggers for the webhook.

Example request

{
  "name": "My Webhook",
  "target_url": "https://example.com/webhook",
  "scope": "folder.direct_children",
  "triggers": [
    "document.created",
    "document.updated"
  ]
}

Response

Successfully created a webhook for a Papersign folder.

status'ok'

Example response

{
  "results": {
    "webhook": {
      "target_url": "https://example.com/webhook",
      "scope": "folder.direct_children",
      "folder": {
        "id": 9999,
        "name": "My Document",
        "parent_id": 9999,
        "space_id": 8888
      },
      "triggers": [
        "document.completed",
        "document.cancelled"
      ]
    }
  }
}