v1

latestOpenAPI 3.0.32026-08-067332206.6 KB
webhooks

Generate a test webhook

Generates a test Webhook.

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

Important: Ensure that your code is able to receive a Brandfolder Webhook using this endpoint before creating a production Webhook subscription.

If you receive a 202 response at this endpoint, then a fake Webhook notification will POST to your callback_url. If you don't receive anything at your callback_url within a few minutes, it is likely that callback_url is invalid. Please ensure the URL begins with https:// and that it is a public domain (not localhost, behind a firewall, or any other domain requiring authentication) which can receive HTTP POST requests and respond with a 2xx HTTP status code.

post/webhooks/send

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",
      "asset_key": "oqgkkd-fr5iv4-443db",
      "organization_key": "oqgkkd-fr5iv4-cocc75"
    }
  }
}

Response

The webhook was successfully created.

messagestring
statusstring