📖 Introduction
Webhooks are automated "Web URLs" belonging to a third-party system or API that AskNicely calls whenever specific events occur. This feature provides a 1-way sync that pushes response data to your external system automatically. Unlike the "Get Responses API," which requires a manual request to fetch data, Webhooks are passive and fire in real-time.
A webhook will fire when a contact submits a score, leaves a comment, or updates their existing score or comment. Each payload includes a count property that increases by one for each update, alongside full details regarding the contact, the question, the score, and the comment.
🚀 Step-by-Step Instructions
Navigate to the App Page (house icon) in your AskNicely account.
Search and click on the Webhooks app.
In the Webhook callback URL input box, enter the destination URL of your third-party system or API.
Click Save.
To test your webhook to ensure data is sending correctly, you can use a service like requestcatcher.com to generate a temporary URL for testing.
To uninstall or disable the integration, clear the Webhook callback URL input box and click Save.
❓ FAQs & Common Issues
Q: When exactly does the webhook fire? A: The webhook fires when a contact submits a score, when they leave a comment, or if they later change their score or comment.
Q: How do I know if a response has been updated? A: Each webhook payload contains a count property. This property increases by 1 every time an update (such as a changed comment or score) occurs for that specific response.
Q: What information is included in the webhook payload? A: Each webhook contains specific details regarding the Contact, the Question asked, the Score given, and any Comment provided.
Q: Can I use this to pull historical data? A: No. Webhooks are a passive, real-time push of data. For manual data retrieval or historical exports, you should use the Get Responses API.
🙋 Need Help?
If you need assistance, contact support@asknice.ly