add status and error fields to webhook records #150
Conversation
| "description": "Status of the Webhook. A disabled webhook will not POST events.", | ||
| "type": "string", | ||
| "default": "enabled", | ||
| "enum": [ |
There was a problem hiding this comment.
Should this have "error" as an option to follow the pattern of Flow Delete Requests? I think the intention of that pattern is that the error object is only present when status is set to error. If we want to follow that pattern, and we want to make this user setable, we might want to think about the best way to indicate the values a client may set and the values a service instance may set. We should also probably describe what a client should do if a webhook enters the error status. e.g. could they set it back to enabled to try again if they fix an issue on the receiving end? Would there be any benefit to having the separate created and started states of the Flow Delete Requests here too? Or is it fair to assume the startup time is negligible?
There was a problem hiding this comment.
I did not think about it to this depth, apologies. You have valid points, my response is "yes"! The difference between created and started might be a way of indicating that at least one POST has occurred since creation? Just thinking out loud. I am certainly not too opinionated on the enum values. I just thought creating this PR was better than just leaving you to iron out the details ;)
|
Merging into #142 to continue work on this there |
2 participants
Details
A very simple PR to suggest a way to add status and error to the webhooks schema.
Jira Issue (if relevant)
Jira URL: n/a
Related PRs
#142
I am targeting this PR into the branch being used for that PR. Do not merge into any other branch.
Submitter PR Checks
(tick as appropriate)
Reviewer PR Checks
(tick as appropriate)
Info on PRs
The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.