SEP-31: add callback URL registration endpoint #1214
Merged
Conversation
This file contains 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
JakeUrban
requested review from
leighmcculloch,
marcelosalloum,
lijamie98 and
stfung77
leighmcculloch
previously approved these changes
May 24, 2022
Yes it is, but I think thats clear from the authentication section. I'll wait for another member of the anchor eng team to approve before merging. |
There was a problem hiding this comment.
There seem to be a few details missing in this change:
- Add this endpoint to the API Endpoints section.
- Mention the usage of this endpoint in the "detailed sending/receiving anchor flows"
|
Thanks for the comments @marcelosalloum ! I definitely missed those items. |
marcelosalloum
approved these changes
May 27, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
resolves #1209
Adds a
PUT /transactions/:id/callbackendpoint for Sending Anchor to request callback requests to a specified URL. This removes the need for Sending Anchors to poll the statuses of in-progress transactions, reducing the chatter between services, especially for anchors with high transaction throughput.I considered adding this functionality into the existing
POST /transactionsandPATCH /transactionsrequests as an optional parameter, but figured that it was likely for Receiving Anchors who did not yet implement this feature to simply ignore thecallback_urlrequest attribute, leading Sending Anchors to believe their callback URL was accepted but never receiving the callback requests.Note: originally we decided not to add this functionality in #636. I disagree with my former self there and don't see why we wouldn't add this capability for the benefit of Sending Anchors that wanted it. Receiving Anchors can chose not to implement this until a Sending Anchors requests it. cc @gaclaudiu