---
title: "Retrieves the webhook profile for the current tenant"
method: GET
path: "/webhook/v1/profile"
tags: ["Webhook profiles"]
---

# Retrieves the webhook profile for the current tenant

`GET /webhook/v1/profile`

Use the /profile end-point to retrieve the webhook profile from the database.<br />User roles: admin

## Query parameters

- `fields` string

## Headers

- `If-None-Match` string

## Response `200`

Success.

- object — A webhook profile.
  - `id` string — The ID of the webhook profile
  - `rev` string — The current revision of the webhook profile.
  - `classification` 'webhook-profile'
  - `creatorId` string — The ID of the user that created the webhook profile.
  - `created` string, date-time — The created date of this webhook profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ.
  - `lastModifierId` string — The ID of the user that last modified the webhook profile.
  - `lastModified` string, date-time — The last modified date of this webhook profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ.
  - `webhooks` object[] — The list of registered webhooks
    - `url` string, required — The URL to execute when firing the webhook. Must be an absolute URL.
    - `secret` string — Optional secret token to use when creating the hash signature to send in a http header. When a secret is specified, the webhook will be sent with an additional `X-IBM-WCH-SIGNATURE` header whose value is the `HmacSHA1` hash of the request body (using the secret as the seed). Webhook receivers can generate their own `HmacSHA1` hash of the request body and compare it to the one sent to verify that the request came from Content. Once the webhook has been saved, a `secretId` will be returned instead of the actual secret.
    - `secretId` string — The ID which was generated to represent your secret. When updating a webhook, include the `secretId` to continue using the same secret. You may also provide a new `secret` to change it or exclude the `secretId` to remove the secret.
    - `active` boolean — Optional flag to indicate whether the webhook is active.
    - `filter` object — Optional filter rules to limit when the webhook will fire. When multiple rules are specified, then ALL must match for the webhook to fire
      - `eventType` string[] — Optional event-types to limit the webhook to. When multiple event-types are specified, then the webhook will fire whenever ANY of the specified event-types occur.
      - `classification` string[] — Optional document classifications to limit the webhook to. When multiple classifications are specified, then the webhook will fire whenever changes occur to ANY of the specified classifications.
      - `status` string[] — Optional document statuses to limit the webhook to. When multiple statuses are specified, then the webhook will fire whenever changes occur to documents in ANY of the specified statuses.
      - `tags` string[] — Optional document tags to limit the webhook to. When multiple tags are specified, then the webhook will fire whenever changes occur to documents with ANY of the specified tags. Note: If tags are specified, then documents without tags will automatically fail the filter

## Other responses

- `304` — Not modified is returned when using If-None-Match header and the value matches the latest version of the item.
- `404` — There is no existing webhook profile.
- `429` — Too Many Requests, the server has reached a limit, the request must be sent again at a later time.

---

[API](https://skmtc.net/goacoustic/apis/acoustic-content-api.md) · [All operations](https://skmtc.net/goacoustic/apis/acoustic-content-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/goacoustic/acoustic-content-api/revisions/677305266d89/schema)