Field and layout considerations

[eddiewebb]

This issue serves as the place to collect feedback on the migration from legacy webhook to this orb.

• Are there specific fields you used not included?
• Did you prefer the 'payload' wrapper element?
• Any other feedbacks, critique about the fields and layout of webhook?

[s5no5t]

Hi @eddiewebb just tried your library and it seems very helpful. Thanks!

One question I have is how to get time data (task run time, workflow run time, waiting time in queue). I see I could pull this data from the http api, but this would require pulling data in a batch job regularly.
Do you see a way to add this data to the webhook itself?

[eddiewebb]

That seems reasonable. I actually have another orb that collects this for in-job display, a little modification to that would allow it to be leveraged in by this orb.
I created eddiewebb/circleci-stats-orb#1 and will start there with something this orb can re-use.

[qugu]

Hi, I may have missed this: but does your orb allow sending a custom payload to the endpoint? I was in an attempt to send a cURL request with headers and payload, but didn't find the relevant fields. Thanks!

[eddiewebb]

Hi @qugu - this orb was a replacement for deprecated notify functionality so it mostly mirrored that. It is fixed payload.

You could easily fork this orb as your own, or depending on need we could add additional fields. It just used environment variables in a curl command.

https://github.com/eddiewebb/circleci-webhook-orb/blob/master/src/commands/notify.yml#L18