Webhook

Tap&Sign can trigger your web service to inform about status of signature and give you the final signed PDF. Webhooks (URL of your web service) are defined in Tap&Sign panel > Account Settings > Tap&Sign Integrator > Webhooks. Defined endpoints ("Bağlantı Noktası") are trigerred by Tap&Sign with the following JSON POST data.

Events:

  1. ENVELOPE_SENT

  2. RECIPIENT_VIEWED

  3. RECIPIENT_SIGNED

  4. ENVELOPE_COMPLETED

  5. ENVELOPE_REJECTED

  6. ENVELOPE_DELETED

Sample webhook post:

{
  "Event": "RECIPIENT_SIGNED",
  "Envelope": {
    "Id": "6cc2b9ff-f0af-45f8-8d94-66a69f72cdd9",
    "Name": "Unordered 10",
    "Data": null,
    "Status": "Completed",
    "CreatedTime": "2024-01-23T08:45:30.2760949",
    "UpdatedTime": "2024-01-23T11:47:34.5564975+03:00",
    "Documents": [
      {
        "Id": "758c0c46-d248-43aa-b799-2ea7958aa101",
        "Name": "acro-field-test.pdf",
        "Data": null,
        "CreatedTime": "2024-01-23T08:45:30.2760969",
        "UpdatedTime": "2024-01-23T08:47:34.4843151",
        "File": {
          "Id": "758c0c46-d248-43aa-b799-2ea7958aa101",
          "Uuid": "758c0c46-d248-43aa-b799-2ea7958aa101",
          "Hash": "",
          "Name": "acro-field-test.pdf",
          "Data": null,
          "Mime_Type": "application/pdf",
          "File_Size": 1375806,
          "Download_Url": "https://api.tapandsign.com/librarian/envelope/6cc2b9ff-f0af-45f8-8d94-66a69f72cdd9/documents/758c0c46-d248-43aa-b799-2ea7958aa101/download",
          "Disk": null
        }
      }
    ],
    "Recipients": [
      {
        "Id": "9445864e-5c9b-47ab-8459-72106b4b87af",
        "Email": "esref.atak@ddtech.com.tr",
        "Name": "John Surname",
        "Phone": "+905335053495",
        "Type": "Signatory",
        "Status": "Completed",
        "Order": "1",
        "ActionUrl": "https://app.tapandsign.com/envelopes/sign/b2d8423d-f84c-4548-a68a-0e21615c9c85",
        "CreatedTime": "2024-01-23T08:45:30.2760984",
        "UpdatedTime": "2024-01-23T08:47:12.2194324",
        "RejectDescription": null
      },
      {
        "Id": "02d4c9a2-7995-4778-bfb1-12747b9b2864",
        "Email": "esrefatak@hotmail.com",
        "Name": "Elisa Surname",
        "Phone": null,
        "Type": "Signatory",
        "Status": "Completed",
        "Order": "2",
        "ActionUrl": "https://app.tapandsign.com/envelopes/sign/b56ded09-3377-4580-8834-9c46381a7d19",
        "CreatedTime": "2024-01-23T08:45:30.2760992",
        "UpdatedTime": "2024-01-23T11:47:34.5530699+03:00",
        "RejectDescription": null
      }
    ],
    "Actor": {
      "RecipientId": "02d4c9a2-7995-4778-bfb1-12747b9b2864",
      "UserId": null,
      "Email": "esrefatak@hotmail.com",
      "Name": "Elisa Surname"
    },
    "Type": "SameDocumentUnorderedSigning"
  }
}

Last updated