ZapSign icon

ZapSign

Interact with ZapSign API for digital signatures

Actions15

Overview

This node integrates with the ZapSign API to manage digital signature workflows. Specifically, for the Webhook resource with the Get Many operation, it retrieves a list of existing webhooks configured in the ZapSign system.

Use cases include:

  • Monitoring all webhook endpoints currently set up to receive event notifications from ZapSign.
  • Auditing or synchronizing webhook configurations between ZapSign and other systems.
  • Automating management tasks that require knowledge of active webhooks.

For example, you might use this node to fetch all webhooks and then filter or update them based on your business logic.

Properties

Name Meaning
Limit Max number of results to return

The Limit property controls how many webhook records are retrieved in one execution. It must be a number greater than or equal to 1, with a default of 50.

Output

The output is a JSON array where each element represents a webhook object as returned by the ZapSign API. Each webhook object typically includes details such as its ID, URL, and subscribed events.

Example structure of one webhook item (fields may vary):

{
  "id": "string",
  "url": "https://example.com/webhook",
  "events": [
    "document.completed",
    "signer.signed"
  ],
  ...
}

No binary data is output for this operation.

Dependencies

  • Requires an API key credential for authenticating with the ZapSign API.
  • The node uses HTTP requests to communicate with the ZapSign service.
  • No additional environment variables are needed beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Exceeding rate limits imposed by the ZapSign API may result in errors.
    • Providing a limit value less than 1 will likely cause validation errors.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • Network or timeout errors suggest connectivity problems; check network access and ZapSign service status.
    • If the response is empty or incomplete, ensure the account has webhooks configured and the limit parameter is set appropriately.

Links and References

Discussion