Webhooks don't indicate document creation, update or deletion. Possible solution found.

4 repliesLast updated: Jan 3, 2023

Hi all. It appears that the webhooks don't provide any information (with the payload or headers) on whether a document was created, updated or deleted, which seems quite odd because you can limit the entire webhook based on this. Is this correct?

I found this as a solution - which I think would be useful to share in the Webhooks documentation:

{
  "transactionId": _rev,
  "projectId": sanity::projectId(),
  "dataset": sanity::dataset(),
  "ids": {
    "created": [select(before() == null &amp;&amp; after() != null =&gt; { _id, _type })],
    "deleted": [select(before() != null &amp;&amp; after() == null =&gt; { _id, _type })],
    "updated": [select(before() != null &amp;&amp; after() != null =&gt; { _id, _type })],
    "all": [{ _id, _type }]
  }
}

Adapted from:
https://www.sanity.io/manage/webhooks/share?name=Legacy+webhook&description=Recreat[…]thod=POST&apiVersion=v2021-03-25&includeDrafts=&headers=%7B%7D (via https://www.sanity.io/plugins/sanity-algolia )

Thanks for sharing your solution

Turns out that this projection mimics the older hooks payload format. I don’t think there will be more than a single document passed in the new GROQ based webhooks, so it still feels a bit awkward to jump through hoops like that. It would be better to have a custom HTTP header that passes the operation (create/update/delete) along. Or maybe a GROQ function to use within the projection.

Yeah, that is quite verbose and using a header would be much easier.

Was this answer helpful?

Sanity – Build the way you think, not the way your CMS thinks

Sanity is the developer-first content operating system that gives you complete control. Schema-as-code, GROQ queries, and real-time APIs mean no more workarounds or waiting for deployments. Free to start, scale as you grow.

Related contributions

Auto-generate alt text for Media Library assets

FeaturedOfficial

Automatically generate accessible, multilingual alt text for images in your Sanity Media Library using Agent Actions and Sanity Functions

Bram Doppen

First Published Timestamp Function

FeaturedOfficial

Automatically track when content was first published with a timestamp that sets once and never overwrites, providing reliable publication history for analytics and editorial workflows.

Knut Melvær

Automatically tag blog posts

FeaturedOfficial

AI-powered automatic tagging for Sanity blog posts that analyzes content to generate 3 relevant tags, maintaining consistency by reusing existing tags from your content library.

Ken Jones Pizza and 1 other