Entity List webhook

The Entity List webhook is described below. Note that webhooks deliver only the event notification. The actual data must be read using the provided event details.

Webhook Subject: ENTITY_LIST

Supported events:

  • CREATE
  • UPDATE
  • DELETE

Summary

Webhook for changes to an entity list e.g. adding a new item to a list (like blogpost listing)

Description

Use the entity list webhook to integrate custom logic like implementing customised ordering for the entity list e.g. when a new item is added, it could be ranked according to it's historical delivery volume.

Note that the entity list, unlike most of the API endpoints at Baack uses a collection list to maintain the membership list, this can however mean that the list can become long however should not become overly long to avoid costly transfer.

Example

Below is an example webhook payload (pretty printed):

{
  "trigger" : {
    "urn" : "6099cb4a-00a5-4e08-8a8d-c570254b5757",
    "owner" : {
      "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
      "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
    },
    "timestamp" : "2026-05-29T13:45:32",
    "subject" : "ENTITY_LIST",
    "event" : "CREATE",
    "targetUrn" : "fdcb0191-8408-4132-abf7-57adeafe59e2"
  },
  "subscription" : {
    "urn" : "691be1de-09df-411d-ad4a-3cc7ec771cd4",
    "subject" : "ENTITY_LIST",
    "event" : "ALL",
    "destinationUrl" : "https://example.com/webhooks/entitylist",
    "auth" : "BEARER",
    "expirationTimestamp" : "2026-06-28T13:45:32",
    "eventsPerMinute" : 500
  },
  "v1" : {
    "urn" : "fdcb0191-8408-4132-abf7-57adeafe59e2",
    "url" : "/n/v1/entitylist/fdcb0191-8408-4132-abf7-57adeafe59e2"
  }
}