---
updatedAt: 2026-07-31T14:10:06.000Z
agentTools:
  projectIndex: https://reference.fidel.uk/llms.txt
---

# Create Webhook (Brand)

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "fidel-api",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.fidel.uk/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Fidel-Key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/hooks": {
      "post": {
        "summary": "Create Webhook (Brand)",
        "description": "",
        "operationId": "create-webhook-brand",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "description": "application/json",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Fidel-Key",
            "in": "header",
            "description": "test/live API secret key.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "event",
                  "url"
                ],
                "properties": {
                  "event": {
                    "type": "string",
                    "description": "The type of event. (values: brand.consent)"
                  },
                  "url": {
                    "type": "string",
                    "description": "URL destination of the event."
                  },
                  "headers": {
                    "type": "object",
                    "description": "A custom header key name that must be between 1 and 64 characters and only accepts roman alphabet, number, dash and underscore. And a value that must be between 1 and 1000 characters.",
                    "properties": {}
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "201",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"items\": [\n    {\n      \"accountId\": \"3693ac7e-3e2b-432c-8c60-2b786453ca9b\",\n      \"event\": \"brand.consent\",\n      \"live\": false,\n      \"url\": \"https://realtime.com\",\n      \"updated\": \"2020-05-05T14:01:29.723Z\",\n      \"created\": \"2020-05-05T14:01:29.723Z\",\n      \"id\": \"afdef5f9-0705-498a-9a4e-fe229cf19651\",\n      \"secretKey\": \"wh_bc_2468d4d7-924a-41a9-b986-8c74b5bae37b\",\n      \"headers\": {\n        \"Custom-Header\": \"my-custom-header\"\n      },\n    }\n  ],\n  \"resource\": \"/v1/hooks\",\n  \"status\": 201,\n  \"execution\": 259.732512\n}"
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "curl",
              "code": "curl -X POST \\\n  https://api.fidel.uk/v1/hooks \\\n  -H 'content-type: application/json' \\\n  -H 'fidel-key: sk_test_50ea90b6-2a3b-4a56-814d-1bc592ba4d63' \\\n  -d '{\n    \"event\": \"brand.consent\",\n    \"url\": \"https://realtime.com\",\n    \"headers\": {\n      \"Custom-Header\": \"my-custom-header\"\n    }\n  }'"
            }
          ],
          "samples-languages": [
            "curl"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```