v1

latestOpenAPI 3.0.32026-08-067332206.6 KB
webhooks

Create a webhook subscription

Subscribes to get Webhook notifications for the specified asset event type within the specified Brandfolder.

Important: This operation uses server https://brandfolder.com/api/v1 (notice the version is v1).

post/webhooks

Request body

Example request

{
  "data": {
    "attributes": {
      "event_type": "asset.create",
      "resource_key": "oqgiju-21olts-ce9egi",
      "resource_type": "brandfolder",
      "callback_url": "https://your_company.com/your_callback_url"
    }
  }
}

Response

The webhook was successfully created.

Example response

{
  "data": {
    "id": "oqgkkd-fr5iv4-hh142d",
    "attributes": {
      "event_type": "asset.create",
      "resource_key": "oqgiju-21olts-ce9egi",
      "resource_type": "brandfolder",
      "callback_url": "https://your_company.com/your_callback_url"
    }
  }
}