Webhook Updates

Important Changes Starting July 1, 2025Copy Anchor Link

We're simplifying our webhook payload structure to make integration cleaner and more straightforward.

What's Changing?Copy Anchor Link

Starting July 1, 2025, all new webhooks will deliver a streamlined payload structure by removing the wrapper data key.

Before (Old Format)Copy Anchor Link

{
  "data": {
    "id": "file_XXX-XXX-XXX-XXX-XXX",
    "filename": "SQUAKE-CompensationCertificate-euc1XXX.pdf",
    "purpose": "confirmation_document",
    "size": 100,
    "type": "pdf",
    "download_url": "https://squake.s3.eu-central-1.amazonaws.com/...."
  }
}

After (New Format)Copy Anchor Link

{
  "id": "file_XXX-XXX-XXX-XXX-XXX",
  "filename": "SQUAKE-CompensationCertificate-euc1XXX.pdf",
  "purpose": "confirmation_document",
  "size": 100,
  "type": "pdf",
  "download_url": "https://squake.s3.eu-central-1.amazonaws.com/...."
}

Security EnhancementCopy Anchor Link

Along with the structural change, we're updating our security implementation:

• Previously: Signature hash was calculated based only on the content inside the data key
• Now: Signature hash is calculated based on the entire webhook body

This provides more comprehensive payload integrity verification.

Timeline & CompatibilityCopy Anchor Link

• Effective Date: July 1, 2025
• Backward Compatibility: Existing webhooks created before July 1, 2025 will continue to work with the current format
• Action Required: No immediate action needed for existing integrations

BenefitsCopy Anchor Link

• Cleaner Structure: Direct access to webhook payload without unnecessary nesting
• Improved Security: Enhanced signature validation covering the entire payload
• Simplified Integration: Easier to parse and work with webhook data

Migration ChecklistCopy Anchor Link

If you're planning to create new webhooks after July 1, 2025:

• Update your webhook handler to expect the new flat structure
• Adjust your signature verification logic to validate the entire body
• Test your integration with the new format before going live

Need Help?Copy Anchor Link

If you have any questions about these changes or need assistance with migration, please don't hesitate to reach out to our support team.