---
title: "Create a REST Hook subscription"
method: POST
path: "/orgs/{orgId}/subscriptions"
tags: ["orgs/subscriptions"]
---

# Create a REST Hook subscription

`POST /orgs/{orgId}/subscriptions`

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

## Path parameters

- `orgId` integer, required

## Request body

- object
  - `hookEventId` integer
  - `hookEventName` string
  - `targetUrl` string
  - `hookActionId` integer
  - `isBlocking` boolean
  - `isVisible` boolean
  - `name` string
  - `description` string, nullable
  - `handlerHookEventLocationId` integer

## Response `201`

Created

- object
  - `data` object
    - `id` number, required
    - `subjectOrg` object
      - `id` integer, required
    - `hookEvent` object
      - `id` integer, required
      - `name` string
      - `description` string
      - `updatedAt` string, date
    - `hookAction` object, nullable
      - `id` integer, required
      - `name` string
      - `description` string, nullable
      - `config` object
      - `updatedAt` string, date
    - `targetUrl` string, nullable
    - `isActive` boolean
    - `isBlocking` boolean
    - `isVisible` boolean
    - `name` string
    - `description` string, nullable
    - `rateLimitCount` integer, nullable
    - `rateLimitWindowSecs` integer, nullable
    - `handlerHookEventLocation` object
      - `id` integer, required
    - `updatedAt` string, date
  - `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/versions/d8a888c114fa/schema)