Asset event webhook service reference

This page specifies the payload structure, event fields, event types, filter configuration, delivery behaviour, and authentication options for the asset event webhook service.

Payload structure

Each webhook delivery is a JSON object with the following structure:

{
  "count": <integer>,
  "events": [<EventObject>, ...],
  "webhookTimestamp": "<ISO-8601 UTC timestamp>"
}
count

Type: integer. The number of event objects included in this payload.

events

Type: array. The list of individual asset change event objects included in this delivery. See Event object for the structure of each object.

webhookTimestamp

Type: ISO-8601 UTC timestamp. The time at which this webhook payload was generated.

Event object

Each element in the events array represents a single change to an asset.

{
  "atomId": <integer or null>,
  "eventId": "<uuid>",
  "eventTimestamp": "<ISO-8601 UTC timestamp>",
  "assetId": <integer>,
  "assetUuid": "<uuid>",
  "eventType": "<string>"
}
atomId

Type: integer or null. Internal reference to the asset’s latest version. Null for PURGED events, where the asset is no longer recoverable.

eventId

Type: UUID. Unique identifier for this event instance. Use this field for deduplication in receiving systems.

assetId

Type: integer. The asset’s internal ID in the source system. Consistent across all events for the same asset.

assetUuid

Type: UUID. Persistent unique identifier for the asset. Remains the same across all versions of the asset.

eventType

Type: string. The type of change that occurred. See Event types for valid values.

eventTimestamp

Type: ISO-8601 UTC timestamp. The time at which the event occurred in the system.

Event types

Event type Description

CREATED

A new asset has been created.

EDITED

An existing asset’s metadata or content has been updated. Multiple edits within a single delivery interval are collapsed into a single EDITED event.

DELETED

The asset has been moved to the Trash and is no longer active. The asset can be restored by an administrator at any time. Treat this event as "archive or hide" in receiving systems — the asset may return via a future EDITED event if restored.

PURGED

The asset has been permanently removed and cannot be recovered. atomId is null for purged events. Purged events bypass all filter evaluation and are always delivered. Treat this event as a signal to permanently remove the asset from receiving systems.

REVERSION

A new binary or version of the asset has been uploaded or promoted.

Filter kinds

Filter kinds define which asset fields a filter evaluates against.

filterKind Payload field Description Example values

keywords

keywords[].value

Tags or keywords attached to the asset.

"CORE", "AF", "A3"

additionalFields

additionalFields[].name / additionalFields[].value

Custom metadata fields. Accepts an optional fieldName parameter to match against a specific field. When fieldName is omitted, the filter matches against values across all additional fields. Specify fieldName in production filters to avoid accidental matches from unrelated fields.

Field: choose_a_brand, Value: "Sensodyne"

state

state

Workflow state of the asset.

"New Asset Upload", "Approved"

schemaId

schemaId

Schema identifier.

"42", "100"

typeId

typeId

Asset type identifier.

"66", "10"

domainId

domainId

Domain or tenant identifier.

"7", "8"

parentId

parentId

Parent asset ID. Use "null" to match top-level assets.

"null", "999"

Filter conditions

The condition field controls how values within a single filter group are matched.

Condition Logic Use case

AND

All specified values must be present.

Asset must have all specified keywords.

ANY

At least one specified value must be present.

Asset must have any one of the specified keywords.

NONE

None of the specified values must be present.

Exclude assets with specific keywords.

The logic between separate filter groups is always AND. All configured filter groups must pass for an event to be delivered.

Filter evaluation rules

Processing order

The service evaluates each event against the following checks in order. An event must pass all applicable checks to be included in delivery.

  1. Purged events bypass all filters: Events with type PURGED always pass through to delivery, regardless of any filter configuration. This ensures hard deletes are never silently dropped.

  2. Resource type check: The event’s supertype must match the configured resourceTypes. If no resourceTypes are configured, only "Resource" supertypes pass by default.

  3. Event type check: If eventTypes are configured, the event must match one of them. If no eventTypes are configured, all event types pass.

  4. ParentId default check: Unless a parentId filter is explicitly configured, only top-level assets (those with parentId: null) pass. Child assets are excluded by default.

  5. Custom filters: Any configured filters are evaluated. All filter groups must pass; the logic between separate filter groups is always AND.

Default behaviours

If a configuration option is omitted, the following defaults apply.

Configuration Default behaviour

No resourceTypes

Only "Resource" supertype events are delivered.

No eventTypes

All event types are delivered.

No filters

No additional filtering is applied.

No parentId filter

Only top-level assets (parentId: null) are delivered.

Delivery behaviour

HTTP method

Webhook requests are sent as HTTP POST requests with a Content-Type of application/json.

Delivery interval

The service executes approximately every minute. All asset change events that occurred within the interval are collected and delivered as a single payload.

Batch size

Each payload contains a maximum of 100 events by default. This limit is configurable — contact App Support if you require a smaller batch size. Payloads are capped at 16 MB regardless of batch size configuration. Where asset activity exceeds these limits within a single interval, multiple payloads are delivered.

EDITED event grouping

Multiple edits to the same asset within a single delivery interval are collapsed into a single EDITED event. The payload reflects the asset’s state at the point of delivery.

Retry behaviour

If the receiving endpoint returns a non-2xx response, the service retries delivery up to five times using exponential backoff, starting at one minute and increasing to a maximum of eight minutes between attempts. Client errors (4xx) are not retried. Events that cannot be delivered within 24 hours are moved to an internal dead-letter store for operator review.

Replay

There is no manual replay mechanism for failed events. If you suspect missed events, contact App Support with the approximate time window and any expected event IDs.

Delivery monitoring

There is no built-in monitoring or alerting for webhook delivery failures. Receiving systems should implement their own observability on the endpoint.

Authentication and headers

API key

The service supports API key authentication via the x-api-key request header. OAuth is not supported. API key values are specified at configuration time. Key rotation is a manual process handled through App Support.

Custom headers

Additional custom headers can be added to webhook requests. Contact App Support to specify custom headers at configuration time.

Configuration template

The following template shows the complete webhook configuration structure. All options marked # OPTIONAL can be omitted; see Filter evaluation rules for default behaviours when omitted.

webhooks:
  tenants:
    - id: "tenant-id"
      webhooks:
        - url: https://your-webhook-endpoint.com/events
          apikey: "optional-api-key"
          enabled: true
          headers:
            X-Custom-Header: "value"
          # OPTIONAL: Resource type filtering
          resourceTypes:
            - "Resource"
            - "Project"
          # OPTIONAL: Event type filtering
          eventTypes:
            - "Created"
            - "Edited"
            - "AssetDeleted"
          # OPTIONAL: Custom filters (all must pass)
          filters:
            - filterKind: keywords
              condition: ANY
              value:
                - "VALUE1"
                - "VALUE2"
            - filterKind: additionalFields
              condition: ANY
              fieldName: "field_name"
              value:
                - "expected_value"
            - filterKind: state
              condition: ANY
              value:
                - "State Name"
            - filterKind: typeId
              condition: ANY
              value:
                - "66"

Related pages