Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.brandsapi.com/llms.txt

Use this file to discover all available pages before exploring further.

BrandApi generates event data that informs you of brand activity. Below are the supported event types you can subscribe to.

​
Brand Events

These events are triggered by changes to brand objects.

​
brand.updated

  • Namespace: brand
  • Description: Triggered anytime a brand’s core data is updated.

​
brand.company.updated

  • Namespace: brand
  • Description: Triggered specifically when a brand’s company-level data is updated.

​
brand.verified

  • Namespace: brand
  • Description: Triggered when a brand’s data has been human-reviewed and verified by our curation team.

​
brand.claimed

  • Namespace: brand
  • Description: Triggered when a brand is officially claimed by its owner.

​
brand.deleted

  • Namespace: brand
  • Description: Triggered when a brand is removed from our index. This is rare and usually happens at the request of the brand owner.

​
Subscribing to Events

You can specify which event types you want to receive when you setup your webhook. Each event payload includes the type field to help your application determine how to process it.