Need help with creating or removing a Webhook? Last updated: May 23, 2023
What Are SortSpoke Webhooks?
DEFINITION:
SortSpoke Webhooks are HTTP callbacks that send event data to a specified URL (Webhook URI) when certain actions take place in the system. These notifications allow your systems to respond immediately to events, facilitating tasks like updating databases, triggering alerts, or initiating subsequent processes.
Completion of document processing
Pre-processing errors
Completion of named batches
Step 1 - Login Use your email address and password to login to SortSpoke.
Step 2 - Go to Admin page Navigate to the Admin page, which can be found in the top right-hand menu. If you do not see the Admin page option, please contact us.
Step 3 - Go to Webhooks page Navigate to the Webhooks page by clicking the Webhooks option on the Admin page.
Step 4 - Add a New Webhook Click on Add New Webhook to create a new webhook for the account.
Step 5 - Add Webhook Settings Details Fill out the Description and Webhook URI and click the Submit button. Ensure the Active switch is set to On, as pictured below, or the events will not be sent to the destination.
Step 6 - Copy your Webhook Secret Key You will see the Webhook Secret Key displayed on screen. Please copy this down for your records. Click here to learn more about Webhook payload validation.
Step 7 - Recent Events History As the events are sent to your webhook you will see a history of the most recent events listed here.
Step 8 - Review the Event Payload The delivered webhook Payload will be similar to the one shown below.
Other Actions - Remove a Webhook Click the Remove action next to any webhook to remove it. Note, this action is permanent and cannot be undone.
Webhook Reliability & Best Practices
UNDERSTANDING WEBHOOK DELIVERY
SortSpoke webhooks utilize an exponential back-off mechanism for retry attempts. While this ensures delivery reliability, it's important to understand how this affects your integration.
When implementing SortSpoke webhooks, you should be aware of the following delivery characteristics:
If your webhook service fails to process an initial notification, subsequent retry attempts will occur at increasingly longer intervals
In some cases, there could be up to a 24-hour delay between retry attempts for persistent failures
This can impact user experience if your processes depend on immediate webhook responses
Recommended Implementation
To ensure optimal data flow and prevent missed documents, we recommend implementing these best practices:
1
Configure Robust Webhook Handling
Ensure your webhook endpoint can properly acknowledge receipt of notifications
Implement appropriate error handling and logging for troubleshooting
Consider setting up redundancy for critical webhook processing
2
Implement Daily Verification
As a safeguard against missed webhooks, schedule a daily import process that:
Runs automatically once per day
Filters for documents from the previous day
Identifies and processes any documents that may have been missed by the webhook system
By following these recommendations, you'll create a resilient integration that maintains data consistency even when webhook delivery issues occur.
Need additional assistance? Contact our support team for personalized guidance on optimizing your webhook implementation.
