Can I programmatically create a Site Deploy Notification?

Support
,
1

I am going to be building a custom website builder type app, where I’ll be using the Netlify API to trigger deploys via a zip file.

The last piece here is that I want our backend to receive a webhook / POST from Netlify when a given site’s deployment state changes (e.g. so we can show to the user a failed, in progress, or succeeded deploy icon).

I see Site Deploy Notifications offer a POST endpoint; however, those docs only show how to manually do it for each site.

Is there an API endpoint to programmatically create that Site Deploy Notification?

Thank you!

2

I’d imagine you’re looking for the Webhooks and Notifications section of the API

image
image814×504 42.7 KB

However I don’t see any obvious examples and cannot advise precisely how to use it, having never done so myself.

In the past I’ve seen Netlify staff recommend inspecting the calls that their UI makes.

3

Yeah, that looks right. Is there no object schema for the API docs? I’m surprised there is no source of truth for things like hook type in there. I guess I’ll go spelunking into the UI!

4

Not everything is documented there - looking at how things are done in the UI is exactly what I would suggest! See this support guide as well: