Build webhook events dont have the correct type

[zenogueira]

Hello,

I’ve tried out the build webhook, and the documentation states that the payload on the build property has a type of Build, but this isn’t correct, as the Build type has a jobs list, and this payload doesn’t.

Is this intended? It would be quite helpful to have these present, especially in distributed build systems, where notification order is never guaranteed.

Thanks in advance for your help

[lizette]

Hi @zenogueira ,

Welcome to the Buildkite Support Community!

Thanks for reaching out and bringing this to our attention. They Build event payloads do not include the jobs as expected in the Build type from the API. I’ll raise this with the team and check if this just requires an update in the docs or the job fields should be there. In the mean time, we have the job events where you can get the details of the job itself.

Cheers!

[zenogueira]

hello,

i understand that the webhooks expose the job events too, but I am really interested in getting all the information on the same payload.

And according to the docs, it seems that you should be sending them.

Thanks in advance for reaching out to the devs and clearing this up, I’ll be waiting for the reply :)

[karen.sawrey]

Hello, @zenogueira!

We have checked and we do not include the jobs’ list within the build event payload in webhooks due to constraints on the payload size itself. We will update the Documentation accordingly. Thanks for pointing this out!

As a workaround for this constraint, you can:

1. Use the Build API endpoint separately to fetch the complete build information including the list of jobs.
2. Use the GraphQL API which provides more detailed build and job information.

Best!