ZapSign Trigger icon

ZapSign Trigger

Starts the workflow when ZapSign events occur

Overview

This node acts as a trigger for workflows based on events from the ZapSign electronic signature platform. It listens for specific document and signer-related events such as when a document is created, sent, viewed, signed, completed, cancelled, expired, or when signers are added, sign, or decline to sign.

Common scenarios where this node is beneficial include:

  • Automating follow-up actions after a document is fully signed.
  • Notifying teams when a document is sent or viewed.
  • Tracking signer activity in real-time.
  • Filtering workflow triggers to specific documents, signers, or brands.

For example, you could use this node to start a workflow that sends a thank-you email once all signers have completed signing a contract, or to update a CRM system when a particular signer signs a document.

Properties

Name Meaning
Events The ZapSign events to listen for. Options include:
- Document Created
- Document Sent
- Document Viewed
- Document Signed
- Document Completed
- Document Cancelled
- Document Expired
- Signer Added
- Signer Signed
- Signer Declined
Document Filter Optional filters to restrict triggering:
- Document ID: Only trigger for a specific document ID
- Signer Email: Only trigger for a specific signer email
- Brand ID: Only trigger for a specific brand ID

Output

The node outputs JSON data representing the event payload received from ZapSign with additional metadata. The output structure includes:

  • event: The event type string (e.g., "document.completed").
  • data: The detailed event data object containing information about the document, signer, etc.
  • metadata: An added object containing:
    • event_type: The event type repeated.
    • received_at: ISO timestamp of when the webhook was received.
    • webhook_source: A fixed string "zapsign" indicating the source of the webhook.

Example output JSON:

[
  {
    "event": "document.completed",
    "data": {
      // event-specific details about the document and signers
    },
    "metadata": {
      "event_type": "document.completed",
      "received_at": "2024-06-01T12:00:00.000Z",
      "webhook_source": "zapsign"
    }
  }
]

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the ZapSign API.
  • Needs proper configuration of the webhook URL in ZapSign via the node's webhook management methods.
  • Supports both sandbox and production environments depending on the credential configuration.

Troubleshooting

  • Webhook registration failure: If the node cannot create or verify the webhook on ZapSign, ensure the API key is valid and has permissions to manage webhooks.
  • Event not triggering: Confirm that the selected events in the node settings match the actual events sent by ZapSign. Also, check if any document filters are too restrictive.
  • Invalid webhook payload: The node expects a specific JSON structure with event and data fields. If ZapSign sends a different format, the node will respond with a 400 error.
  • Filter mismatches: If the workflow never triggers, verify that the document ID, signer email, or brand ID filters correspond exactly to the values in the incoming event data.

Links and References

Discussion