---
title: "Describe a hook event"
method: GET
path: "/orgs/{orgId}/hookEvents/{hookEventId}"
tags: ["orgs/hookEvents"]
---

# Describe a hook event

`GET /orgs/{orgId}/hookEvents/{hookEventId}`

__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeHookEvent

## Path parameters

- `orgId` integer, required
- `hookEventId` integer, required

## Response `200`

Successful

- object
  - `data` object
    - `id` number, required
    - `name` string
    - `description` string
    - `hookEventLocation` object
      - `id` number, required
      - `name` string
      - `acceptsTargetUrl` boolean
      - `acceptsHookAction` boolean
    - `hookEventLocations` object[]
      - `id` number, required
      - `name` string
      - `acceptsTargetUrl` boolean
      - `acceptsHookAction` boolean
    - `requiredFeature` object, nullable
      - `id` integer, required
      - `code` string
    - `isCloudRecorded` boolean, required
    - `fieldMap` object, nullable
    - `flags` object, nullable
  - `meta` object
    - `accessToken` object, nullable
      - `scopeUpdatedAt` string, date
    - `siteSpecificAccess` object, nullable
      - `isSiteSpecific` boolean
      - `siteIds` integer[], nullable
      - `siteIdsByScope` object, nullable
        - `string` integer[], nullable

---

[API](https://skmtc.net/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.net/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/revisions/d8a888c114fa/schema)