feat!: add prepayments webhook endpoint and schema - #838
Merged
the-chris-mitchell merged 4 commits intoAug 12, 2026
Merged
Conversation
BREAKING CHANGE: adds PREPAYMENT as a new eventCategory oneOf value in xero-webhooks.yaml. Existing strict schema validators may reject this new enum value in webhook payloads; this is expected since subscribers must explicitly opt in to prepayment events.
…bhook' into ecoam-5825-add-new-prepayment-webhook
the-chris-mitchell
approved these changes
Aug 12, 2026
|
🎉 This PR is included in version 17.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds the Prepayments webhook to xero-webhooks.yaml, including the PREPAYMENT event category, PrepaymentWebhookEvent schema, and a create-event example aligned with the Credit Notes webhook pattern.
Changes
New webhooks/prepayments endpoint (publishPrepaymentEvent)
PrepaymentWebhookEvent with data.Type, data.Status, and data.UpdatedDateUTCString
PREPAYMENT added to eventCategory enum
https://xero.atlassian.net/browse/ECOAM-5825