Troubleshooting Common JSON Payload Errors

Follow the steps below to resolve common issues you may encounter in Webhooks by Symmetry JSON payloads.

1. Did not receive JSON payload

  • Confirm the webhook status is set to enabled.
  • Check the webhook logs to see if an error was returned. If an error was returned, refer to the troubleshooting steps below on how to correct for specific errors.
  • Confirm the webhook callback URL is correct and pointing to the correct server location.
  • Confirm the trigger criteria is correct. See troubleshooting steps below on how to confirm the trigger criteria is correct.

If an error is not returned and the webhook is enabled, most likely the trigger criteria needs to be adjusted. 

Interface changes not available in Webhooks

Webhooks allows clients to see a number of changes within the Symmetry Tax Engine; however, interface changes are not available. This includes changes to endpoints. Refer to the complete list of event types available within Webhooks by Symmetry.

 

2. Did not receive the data you intend to see

  • Confirm the webhook status is set to enabled.
  • Confirm the trigger criteria is correct. The event type, state selection, and tax types must be true in order for the trigger to fire. See below for an example.

Webhook Trigger Example

The following trigger criteria is established:

  • Event - all events
  • States - 00 - Federal; 06 - California
  • Tax Types - all tax types

Scenario 1: Release 2022-R6 of the STE included a new California tax. In this scenario, the trigger conditions are met for this webhook and you would receive the payload with this change.

Scenario 2: Release 2022-R7 of the STE included a new Massachusetts tax. In this scenario, the trigger conditions are not met for this webhook because we are only listening for changes related to California and Federal jurisdictions. 

 

3. Received an error instead of payload

  • Review the HTTP error code returned:
    • 4xx errors codes indicate a problem with submitted data
    • 5xx error codes indicate a problem with the application itself
  • For 404 errors, confirm the webhook callback URL is correct and pointing to the correct server location.

 

 

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.