Home›Integrations›SearchIndexDelete

SearchIndexDelete

Payload sent when an item is removed from the Interact search index, and a reference for the common webhook envelope.

Overview

The SearchIndexDelete webhook fires when an item is removed from the search index. Because the item no longer exists, the payload identifies what was removed rather than carrying the item's data.

This page also serves as the reference for the webhook envelope — the outer structure shared by the search index webhooks. The SearchIndexAddUpdate payload uses the same envelope, but with documentdata populated.

Example payload

{
  "type": "SearchIndexDelete",
  "generatedtime": "2019-10-10T12:50:29.632504Z",
  "data": {
    "changetype": "Delete",
    "objecttype": "Document",
    "objectid": "12313425",
    "documentdata": null
  }
}

Payload fields

Field Description
type The name of the webhook that fired — SearchIndexDelete.
generatedtime The UTC date and time the event was generated.
data.changetype The kind of change. Delete for this webhook.
data.objecttype The type of object removed from the index. See the enumerated search types for the full list.
data.objectid The identifier of the object that was removed.
data.documentdata The item's indexed data. null for a deletion, because the item no longer exists. For additions and updates it is populated — see SearchIndexAddUpdate.
Section: Integrations