Webhooks in Guides: Overview
Webhooks in Guides gives your team real-time, automated tax change updates. These are delivered directly to your server as a JSON notification. When Symmetry publishes a new tax or new tax rate in Guides, any webhook you have configured will fire automatically, without any manual action on your part.
Webhooks are available to all Guides clients and are managed directly in your account Settings in Guides. You can register up to five active webhook endpoints per account.
How to create a webhook
Follow the below steps to create up to five webhooks from Symmetry Guides:
- Access Symmetry Guides (use your Auth0 login).
- Access the admin settings by clicking dropdown next to the profile circle at the top right of the screen, then click Settings.
- Click the Manage webhooks button.
- From the Configuration tab, add your Callback URL and an optional Description, then click the Add webhook button.
- Once added, your webhook will be visible within the Configuration tab. You can Send test, Edit, or Remove the webhook directly from this screen.
Troubleshooting
If you are not receiving webhooks as expected, follow the steps below.
- Confirm the correct Callback URL is configured in Guides (Settings > Manage Webhooks).
- Check the Activity tab for delivery status (Settings > Manage Webhooks > Activity > Details).
- 4xx errors indicate a problem with the submitted data and will not be retried. Confirm your callback URL is correct and pointing to the right server location.
- 5xx errors indicate a server-side issue. Guides will automatically retry delivery two additional times.