How to Set Up Post-Completion Redirect URLs
Configure automatic redirects for recipients after document completion
How to Set Up Post-Completion Redirect URLs
Problem
You need to redirect document recipients to a specific URL after they complete signing or paying for a document. This is useful for:
- Directing recipients to checkout pages for payment providers not integrated with PandaDoc
- Collecting additional information through forms
- Providing branded thank-you pages
- Creating custom post-completion workflows
Prerequisites
- Business or Enterprise plan (unavailable during trial period)
- Basic familiarity with PandaDoc API endpoints
- HTTPS URLs for redirect destinations (plain HTTP not supported, only secure HTTPS)
Solution
Step 1: Add Redirect Parameter to Recipients
Add the redirect
parameter to a recipient payload when creating or updating documents. You can set redirects per recipient for documents, while template-level redirects apply to all recipients.
"recipients": [
{
"first_name": "Josh",
"last_name": "Ron",
"email": "[email protected]",
"phone": "15551234567",
"redirect":
{
"url": "https://example.com/checkout",
"is_enabled": true
}
}
]
Step 2: Choose the Appropriate Endpoint
Use any of these endpoints to configure redirect URLs:
- Create a Document from a Template
- Create a Document from a File Upload
- Update a Document
- Update Recipient
- Create Document Section from Template
- Create a Document Section from a File
Verification
To confirm your redirect URLs are configured correctly:
- Use the Document Details endpoint to retrieve redirect information
- Test the document completion flow
- Verify the redirect occurs automatically after signing/payment completion
Troubleshooting
Issue: Redirect not working
- Ensure the URL uses HTTPS (HTTP is not supported)
- Verify
is_enabled
is set totrue
- Check that the recipient has the correct redirect configuration
- Redirect is not supported for Embedded Signing. If you embed the signing session and need to redirect after document signing, use
session_view.document.completed
event to implement in in your frontend application instead. Read more about Embedded Signing Actions
Issue: Development environment limitations
- Ensure your development URLs are publicly accessible
Related
- Document Details API Reference - Get redirect configuration details
- Redirect Feature Support Article - Additional feature information
Updated about 13 hours ago