---
updatedAt: 2026-09-09T09:34:50.000Z
agentTools:
  siteIndex: https://documentation.bloomreach.com/llms.txt
  projectIndex: https://documentation.bloomreach.com/content/llms.txt
---

# Get a webhook configuration

Gets a webhook configuration.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Webhook Management API",
    "description": "The Webhook Management API enables developers to create, update, get and delete webhooks",
    "version": "1.0.0"
  },
  "externalDocs": {
    "description": "See official Bloomreach documentation",
    "url": "https://documentation.bloomreach.com/content/reference/webhook-management-api"
  },
  "servers": [
    {
      "url": "https://developers.bloomreach.io/management/webhooks/v1"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/configurations/{webhook_configuration_id}": {
      "get": {
        "tags": [
          "Webhook Configuration Operations"
        ],
        "summary": "Get a webhook configuration",
        "operationId": "getWebhookConfiguration",
        "description": "Gets a webhook configuration.",
        "parameters": [
          {
            "name": "webhook_configuration_id",
            "in": "path",
            "description": "identifier of the webhook configuration",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            },
            "example": "31b516c6-ec50-482b-a253-dde93e7837e9"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Resource-Version": {
                "description": "Resource's version. Must be used in any subsequent update requests of this resource",
                "style": "simple",
                "explode": false,
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookConfiguration"
                },
                "examples": {
                  "A webhook configuration": {
                    "$ref": "#/components/examples/WebhookConfigurationResponseExample"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  },
  "components": {
    "examples": {
      "WebhookConfigurationResponseExample": {
        "value": {
          "id": "31b516c6-ec50-482b-a253-dde93e7837e9",
          "name": "Document publish",
          "enabled": true,
          "url": "https://api.bloomreach.io/rest/document",
          "method": "POST",
          "triggers": [
            "document:publish"
          ],
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json",
              "secret": false
            }
          ],
          "system": {
            "createdBy": "site-admin",
            "createdAt": "2023-12-13T13:27:29.474+01:00",
            "updatedBy": "site-admin",
            "updatedAt": "2023-12-13T13:27:29.474+01:00"
          }
        }
      }
    },
    "schemas": {
      "WebhookConfiguration": {
        "required": [
          "name",
          "url",
          "method",
          "triggers"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "identifier of the webhook configuration. autogenerated during create webhook configuration operation"
          },
          "name": {
            "type": "string",
            "description": "identifying name of the webhook configuration"
          },
          "enabled": {
            "type": "boolean",
            "description": "whether the webhook configuration is enabled. this allows executing a webhook call in case a new event is triggered"
          },
          "url": {
            "type": "string",
            "description": "url of the webhook call"
          },
          "method": {
            "$ref": "#/components/schemas/WebhookConfigurationMethod"
          },
          "triggers": {
            "type": "array",
            "description": "events that triggers webhook calls",
            "items": {
              "$ref": "#/components/schemas/WebhookConfigurationTrigger"
            }
          },
          "headers": {
            "type": "array",
            "description": "headers used in webhook calls",
            "items": {
              "$ref": "#/components/schemas/WebhookConfigurationHeader"
            }
          },
          "system": {
            "$ref": "#/components/schemas/System"
          }
        },
        "description": "A webhook configuration"
      },
      "WebhookConfigurationHeader": {
        "required": [
          "name",
          "value"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "identifying name of the webhook configuration header"
          },
          "value": {
            "type": "boolean",
            "description": "value of te webhook configuration header"
          },
          "secret": {
            "type": "boolean",
            "description": "whether the webhook configuration header contains a secret value"
          }
        },
        "description": "A webhook configuration header"
      },
      "WebhookConfigurationMethod": {
        "type": "string",
        "description": "HTTP Method\n* POST - POST operation",
        "enum": [
          "POST"
        ]
      },
      "WebhookConfigurationTrigger": {
        "type": "string",
        "description": "Trigger event\n* document:publish - document publish event\n* document:unpublish - document unpublish event\n* page:publish - page publish event\n* page:unpublish - page unpublish event",
        "enum": [
          "document:publish",
          "document:unpublish",
          "page:publish",
          "page:unpublish"
        ]
      },
      "System": {
        "type": "object",
        "readOnly": true,
        "properties": {
          "createdBy": {
            "type": "string",
            "description": "the name of the user that created the webhook configuration"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "date of create"
          },
          "updatedBy": {
            "type": "string",
            "description": "the name of the user that updated the webhook configuration"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "date of update"
          }
        },
        "description": "System properties"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "apiKey",
        "name": "x-auth-token",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```