Document current state of merge request webhooks
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
A webhook-related conversation Kai and I participated in reminded me that we've never delved into documenting our webhooks properly:
Kai: I don't know if merge request webhooks actually contain pipeline information (I don't readily see it in the example payload, but our webhook docs aren't the best). I think we have a pipeline webhook though... which does tell you which merge request its for, so you'd probably want to consume that webhook
Kai: I think for some webhook payloads we show both an old and new value... but I don't really know the specifics of that either... it might just be for certain fields. That's what we do for
draftfor example, we providepreviousandcurrent. So it could be that something similar for pipeline status (like the customer suggested) would make sense here too
I asked what would be needed. His response:
Probably similar things to the API docs... document each field, how it works, more examples of different events.
I can't legitimately look at our webhook docs and reason anything. I'd have to setup a webhook receiver and then trigger a whole bunch. At one point in time, I had that setup locally... but haven't revisited it.